Skip to main content

Query DB for BGP Peers (v2.4)

POST 

/v2.4/api/tenants/:tenant_id/bgppeers/query

Queries the DB for limit number of BGP peers that match the query parameters.

Request

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

Body

Query Details for BGP Peers

    aggregate Aggregate

    The aggregate number of BGP peers 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

    Field

    name string

    The name of the query response.

    operator string

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

    Operator

    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of BGP peers deleted for a time frame.

    group_by string[]

    Group the BGP peers for the query.

    id string

    Lists the BGP peers 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.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number.

    items BGPPeerQueryFilterV2N4[]
  • Array [
  • allow_v4_prefixes booleanrequired

    Allow v4 prefixes.

    allow_v6_prefixes booleanrequired

    Allow v6 prefixes.

    bgp_config BGPConfig

    The details of the BGP config.

    adv_interval int32

    The advertisement interval of the BGP config. The advertisement interval should be between 0 - 300 seconds and the default is 1 second.

    hold_time int32

    The BGP config hold time. The hold time should be between 3 - 600 seconds.

    keepalive_time int32

    The keep-alive time of the BGP config. The keep-alive time should be between 3 - 200 seconds.

    local_as_num string

    The Local AS Number should be between 1 and 4294967295 or as A.B, where A and B are both numbers between 1 and 4294967295.

    md5_secret string

    The MD5 Secret should be between 1 and 32 characters. The default value is 0.

    multi_hop_limit int32

    The BGP config multi hop limit. The multi-hop limit should be between 1 - 255 hops. The default is 1 hop.

    peer_auth_type string

    Possible values: [md5, none]

    The authentication type of the BGP peer.

    peer_retry_time int32

    The peer retry time should be between 0 - 65535 seconds. The default is 120 seconds.

    description

    The description of the BGP peer config. Max size = 1024.

    id string

    The ID of the BGP peer config.

    name stringrequired

    The name of the BGP peer config. Max size = 128.

    peer_ip string

    The peer IP address.

    peer_ip_v6 string

    The peer IPv6 address.

    peer_type string

    The peer type = Classic. The Peer Type option is available only for data center ION devices.

    remote_as_num stringrequired

    The remote AS number.

    route_map_in_id string

    The ID of the Route Map In to filter incoming routes.

    route_map_out_id string

    The ID of the Route Map Out to filter outgoing routes.

    router_id string

    The IP address of the ION device. Max size = 256.

    scope string

    Possible values: [GLOBAL, LOCAL]

    The scope of the static route = Local or Global. If scope is local, the device does not advertise the route to other sites and if scope is global, the device advertises the route to other sites.

    shutdown boolean

    Shutdown

    tags string[]

    A information field that can be added to identify the BGP peer. Maximum 10 unique tags of length 1024 each are allowed.

    update_source string

    The Update Source IP address.

    update_source_v6 string

    The Update Source IPv6 address.

    vrf_context_id string

    The VRF (Virtual Routing and Forwarding) ID.

  • ]
Loading...