scc_firewall_manager_sdk.InterfaceHealthAggregationsApi¶

All URIs are relative to the base URL, which depends on the region your organization is deployed to.

Region	Base URL
US	https://api.us.security.cisco.com/firewall
EU	https://api.eu.security.cisco.com/firewall
APJ	https://api.apj.security.cisco.com/firewall
AU	https://api.au.security.cisco.com/firewall
IN	https://api.in.security.cisco.com/firewall
UAE	https://api.uae.security.cisco.com/firewall

Method	HTTP request	Description
get_interface_health_metric_aggregation_list	GET /v1/inventory/devices/health/interfaces/aggregations/details	Get device interface detailed list for aggregations
get_interface_health_metric_aggregations	GET /v1/inventory/devices/health/interfaces/aggregations	Get interface health metric aggregations
get_interface_health_metric_error_aggregations	GET /v1/inventory/devices/health/interfaces/errors/aggregations	Get interface health metric error aggregations

get_interface_health_metric_aggregation_list¶

MetricAggregationListResponse get_interface_health_metric_aggregation_list(metric, threshold, aggregation_period=aggregation_period, managed_tenant_uid=managed_tenant_uid, q=q)

Get device interface detailed list for aggregations

Retrieve filtered device interface detailed list corresponding to aggregation metrics.

Example¶

Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.metric_aggregation_list_response import MetricAggregationListResponse
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.us.security.cisco.com/firewall
# See configuration.py for a list of all supported configuration parameters.
configuration = scc_firewall_manager_sdk.Configuration(
    host = "https://api.us.security.cisco.com/firewall"
)

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.InterfaceHealthAggregationsApi(api_client)
    metric = 'linkStatus' # str | The metric for the device interface health aggregation detailed list. (e.g. linkStatus,overruns).
    threshold = 'CRITICAL' # str | The metric threshold (e.g. CRITICAL).
    aggregation_period = '24h' # str | The aggregation period of the metrics returned. (optional)
    managed_tenant_uid = '7131daad-e813-4b8f-8f42-be1e241e8cdb' # str | A managed tenant UUID to filter list, if applicable. (optional)
    q = 'name:my-interfac*' # str | Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering. (optional)

    try:
        # Get device interface detailed list for aggregations
        api_response = api_instance.get_interface_health_metric_aggregation_list(metric, threshold, aggregation_period=aggregation_period, managed_tenant_uid=managed_tenant_uid, q=q)
        print("The response of InterfaceHealthAggregationsApi->get_interface_health_metric_aggregation_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InterfaceHealthAggregationsApi->get_interface_health_metric_aggregation_list: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
metric	str	The metric for the device interface health aggregation detailed list. (e.g. linkStatus,overruns).
threshold	str	The metric threshold (e.g. CRITICAL).
aggregation_period	str	The aggregation period of the metrics returned.	[optional]
managed_tenant_uid	str	A managed tenant UUID to filter list, if applicable.	[optional]
q	str	Lucene-style query filter. Only prefix queries (e.g. field:value) and wildcard queries (e.g. field:value or field:value) are supported for filtering.	[optional]

Return type¶

MetricAggregationListResponse

Authorization¶

bearerAuth

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Successfully retrieved device interface metric aggregation detailed list.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
404	Entity not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_interface_health_metric_aggregations¶

MetricAggregationResponse get_interface_health_metric_aggregations(metrics=metrics, aggregation_period=aggregation_period)

Get interface health metric aggregations

Retrieve aggregation interface health metrics for all managed devices.

Example¶

Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.metric_aggregation_response import MetricAggregationResponse
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.us.security.cisco.com/firewall
# See configuration.py for a list of all supported configuration parameters.
configuration = scc_firewall_manager_sdk.Configuration(
    host = "https://api.us.security.cisco.com/firewall"
)

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.InterfaceHealthAggregationsApi(api_client)
    metrics = 'linkStatus,overruns' # str | Comma-separated list of metrics to return (e.g. linkStatus,overruns). Returns all if omitted. (optional)
    aggregation_period = '24h' # str | The aggregation period of the metrics returned (optional)

    try:
        # Get interface health metric aggregations
        api_response = api_instance.get_interface_health_metric_aggregations(metrics=metrics, aggregation_period=aggregation_period)
        print("The response of InterfaceHealthAggregationsApi->get_interface_health_metric_aggregations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InterfaceHealthAggregationsApi->get_interface_health_metric_aggregations: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
metrics	str	Comma-separated list of metrics to return (e.g. linkStatus,overruns). Returns all if omitted.	[optional]
aggregation_period	str	The aggregation period of the metrics returned	[optional]

Return type¶

MetricAggregationResponse

Authorization¶

bearerAuth

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Successfully retrieved interface metric aggregations.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
404	Entity not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_interface_health_metric_error_aggregations¶

InterfaceMetricErrorAggregationResponse get_interface_health_metric_error_aggregations(aggregation_period=aggregation_period)

Get interface health metric error aggregations

Retrieve aggregation of interface health metrics errors for all managed devices.

Example¶

Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.interface_metric_error_aggregation_response import InterfaceMetricErrorAggregationResponse
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.us.security.cisco.com/firewall
# See configuration.py for a list of all supported configuration parameters.
configuration = scc_firewall_manager_sdk.Configuration(
    host = "https://api.us.security.cisco.com/firewall"
)

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.InterfaceHealthAggregationsApi(api_client)
    aggregation_period = '24h' # str | The aggregation period of the metrics returned (optional)

    try:
        # Get interface health metric error aggregations
        api_response = api_instance.get_interface_health_metric_error_aggregations(aggregation_period=aggregation_period)
        print("The response of InterfaceHealthAggregationsApi->get_interface_health_metric_error_aggregations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling InterfaceHealthAggregationsApi->get_interface_health_metric_error_aggregations: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
aggregation_period	str	The aggregation period of the metrics returned	[optional]

Return type¶

InterfaceMetricErrorAggregationResponse

Authorization¶

bearerAuth

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Successfully retrieved interface metric error aggregations.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
404	Entity not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]