openapi_client.RealTimeMonitoringOSPFApi

All URIs are relative to /dataservice

Method	HTTP request	Description
create_ospf_database_external	GET /device/ospf/databaseexternal
create_ospf_database_list	GET /device/ospf/database
create_ospf_database_summary_list	GET /device/ospf/databasesummary
create_ospf_interface	GET /device/ospf/interface
create_ospf_neighbors	GET /device/ospf/neighbor
create_ospf_process	GET /device/ospf/process
create_ospf_routes_list	GET /device/ospf/routes
create_ospfv3_interface	GET /device/ospf/v3interface
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

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]

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

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] [Back to Model list] [Back to README]

Files

RealTimeMonitoringOSPFApi.md

Latest commit

History

RealTimeMonitoringOSPFApi.md

File metadata and controls

openapi_client.RealTimeMonitoringOSPFApi

create_ospf_database_external

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_ospf_database_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_ospf_database_summary_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_ospf_interface

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_ospf_neighbors

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_ospf_process

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_ospf_routes_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_ospfv3_interface

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_ospfv3_neighbors

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details