BgpNeighborConfig

Contains information necessary to configure a BGP neighbor.


Properties

integer
_create_time Optional

Timestamp of resource creation


string
_create_user Optional

ID of the user who created this resource


integer
_last_modified_time Optional

Timestamp of last modification


string
_last_modified_user Optional

ID of the user who last modified this resource


array of ResourceLink
_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.


string
_protection Optional

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.


integer
_revision Optional

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.


string
_schema Optional

Schema for this resource


_self Optional

Link to this resource


boolean
_system_owned Optional

Indicates system owned resource


boolean
allow_as_in Optional

Flag to enable allowas_in option for BGP neighbor


bfd Optional

BFD configuration for failure detection. BFD is enabled with default values when not configured.


children Optional

subtree for this type within policy tree containing nested elements.


string
description Optional

Description of this resource


string
display_name Optional

Defaults to ID if not set


string
graceful_restart_mode Optional

If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.

Possible values are: DISABLEGR_AND_HELPERHELPER_ONLY


integer
hold_down_time Optional

Wait time in seconds before declaring peer dead.


string
id Optional

Unique identifier of this resource


array of string
in_route_filters Optional

Specify path of prefix-list or route map to filter routes for IN direction. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.


integer
keep_alive_time Optional

Interval (in seconds) between keep alive messages sent to peer.


boolean
marked_for_delete Optional

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.


integer
maximum_hop_limit Optional

Maximum number of hops allowed to reach BGP neighbor.


string
neighbor_address Optional

Neighbor IP Address


array of string
out_route_filters Optional

Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named ‘prefixlist-out-default’ is automatically applied. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.


string
parent_path Optional

Path of its parent


string
password Optional

Specify password for BGP neighbor authentication. Empty string (“”) clears existing password.


string
path Optional

Absolute path of this object


string
relative_path Optional

Path relative from its parent


string
remote_as_num Optional

4 Byte ASN of the neighbor in ASPLAIN Format


string
resource_type Optional

The type of this resource.


route_filtering Optional

Enable address families and route filtering in each direction.


array of string
source_addresses Optional

Source addresses should belong to Tier0 external or loopback interface IP Addresses . BGP peering is formed from all these addresses. This property is mandatory when maximum_hop_limit is greater than 1.


array of Tag
tags Optional

Opaque identifiers meaningful to the API user

JSON Example

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "allow_as_in": false,
    "bfd": {
        "enabled": false,
        "interval": 0,
        "multiple": 0
    },
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "graceful_restart_mode": "string",
    "hold_down_time": 0,
    "id": "string",
    "in_route_filters": [
        "string"
    ],
    "keep_alive_time": 0,
    "marked_for_delete": false,
    "maximum_hop_limit": 0,
    "neighbor_address": "string",
    "out_route_filters": [
        "string"
    ],
    "parent_path": "string",
    "password": "string",
    "path": "string",
    "relative_path": "string",
    "remote_as_num": "string",
    "resource_type": "string",
    "route_filtering": [
        {
            "address_family": "string",
            "enabled": false,
            "in_route_filters": [
                "string"
            ],
            "out_route_filters": [
                "string"
            ]
        }
    ],
    "source_addresses": [
        "string"
    ],
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ]
}
Feedback

Was this page helpful?