BgpNeighborConfig

Contains information necessary to configure a BGP neighbor.


Properties

Required Property Name Type Description
optional _create_time integer

Timestamp of resource creation

optional _create_user string

ID of the user who created this resource

optional _last_modified_time integer

Timestamp of last modification

optional _last_modified_user string

ID of the user who last modified this resource

optional _links array of ResourceLink

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

optional _protection string

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.

optional _revision integer

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.

optional _schema string

Schema for this resource

optional _self SelfResourceLink

Link to this resource

optional _system_owned boolean

Indicates system owned resource

optional allow_as_in boolean

Flag to enable allowas_in option for BGP neighbor

optional bfd BgpBfdConfig

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

optional children array of ChildPolicyConfigResource

subtree for this type within policy tree containing nested elements.

optional description string

Description of this resource

optional display_name string

Defaults to ID if not set

optional graceful_restart_mode string

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.

optional hold_down_time integer

Wait time in seconds before declaring peer dead.

optional id string

Unique identifier of this resource

optional in_route_filters array of string

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.

optional keep_alive_time integer

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

optional marked_for_delete boolean

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.

optional maximum_hop_limit integer

Maximum number of hops allowed to reach BGP neighbor.

optional neighbor_address string

Neighbor IP Address

optional out_route_filters array of string

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.

optional parent_path string

Path of its parent

optional password string

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

optional path string

Absolute path of this object

optional relative_path string

Path relative from its parent

optional remote_as_num string

4 Byte ASN of the neighbor in ASPLAIN Format

optional resource_type string

The type of this resource.

optional route_filtering array of BgpRouteFiltering

Enable address families and route filtering in each direction.

optional source_addresses array of string

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.

optional tags array of Tag

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?