Skip to main content

Query OSPF Reachable Prefixes (v2.0)

POST 

/sdwan/v2.0/api/ospfreachableprefixes/query

Queries the OSPF reachable prefixes that match the query parameters.

Request

Body

Query Details for OSPF reachable prefixes

    aggregate Aggregate

    The aggregate number of OSPF reachable prefixes that match the query parameters.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
  • field string

    The field value.

    name string

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]

    The operator values.

    statistic string

    The aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number OSPF reachable prefixes deleted for a time frame.

    group_by string[]

    Group the OSPF reachable prefixes for the query.

    id string

    List the OSPF reachable prefixes by ID.

    last_query_ts int64

    Return the ID of a specified query in the current session.

    limit int32

    The query limit.

    next_query object

    The limit.

    query_params object
    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object
    total_count int64

    The total number of query parameters.

Responses

Successful Operation

Schema
    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.

    description

    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    total_count int64

    Total number.

    items OspfReachablePrefixesFilter[]
  • Array [
  • id string

    The OSPF reachable prefix ID.

    ospf_config_id string

    The OSPF config ID.

    reachable_ipv4_prefixes PrefixInfo[]

    The reachable IPv4 prefixes for OSPF.

  • Array [
  • as_path int64[]

    The AS path of the IPv4/IPv6 prefix.

    network string

    The network of the IPv4/IPv6 prefix.

    nexthop string

    The next-hop of the IPv4/IPv6 prefix.

  • ]
  • reachable_ipv4_prefixes_count int32

    The reachable IPv4 prefixes count for OSPF.

    redistribute boolean

    True or False.

    vrf_context_id string

    The attached VRF (Virtual Routing and Forwarding) ID.

  • ]
Loading...