{
"additionalProperties": false,
"extends": {
"$ref": "ManagedResource
},
"id": "BgpNeighbor",
"module_id": "Routing",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "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.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "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.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"address_families": {
"description": "User can enable the neighbor for the specific address families and also define filters per address family. When the neighbor is created, it is default enabled for IPV4_UNICAST address family for backward compatibility reasons. User can change that if required, by defining the address family configuration.",
"items": {
"$ref": "BgpNeighborAddressFamily
},
"required": false,
"title": "AddressFamily settings for the neighbor",
"type": "array"
},
"allow_as_in": {
"default": false,
"required": false,
"title": "Flag to enable allowas_in option for BGP neighbor",
"type": "boolean"
},
"bfd_config": {
"$ref": "BfdConfigParameters,
"description": "By specifying these paramaters BFD config for this given peer can be overriden | (the globally configured values will not apply for this peer)",
"required": false,
"title": "BFD Configuration Parameters for the given peer."
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"enable_bfd": {
"default": false,
"description": "Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.",
"required": false,
"title": "Enable BFD for this BGP Neighbor",
"type": "boolean"
},
"enabled": {
"default": true,
"required": false,
"title": "Flag to enable this BGP Neighbor",
"type": "boolean"
},
"filter_in_ipprefixlist_id": {
"deprecated": true,
"description": "This is a deprecated property, Please use 'address_family' instead.",
"required": false,
"title": "IPPrefix List to be used for IN direction filter for IPV4_UNICAST address family",
"type": "string"
},
"filter_in_routemap_id": {
"deprecated": true,
"description": "This is a deprecated property, Please use 'address_family' instead.",
"required": false,
"title": "RouteMap to be used for IN direction filter for IPV4_UNICAST address family",
"type": "string"
},
"filter_out_ipprefixlist_id": {
"deprecated": true,
"description": "This is a deprecated property, Please use 'address_family' instead.",
"required": false,
"title": "IPPrefixList to be used for OUT direction filter for IPV4_UNICAST address family",
"type": "string"
},
"filter_out_routemap_id": {
"deprecated": true,
"description": "This is a deprecated property, Please use 'address_family' instead.",
"required": false,
"title": "RouteMap to be used for OUT direction filter for IPV4_UNICAST address family",
"type": "string"
},
"graceful_restart_mode": {
"$ref": "GracefulRestartMode,
"description": "BGP Graceful Restart mode. If specified, then it will take precedence over global Graceful Restart mode configured in logical router BgpConfig otherwise BgpConfig level Graceful Restart mode will be applicable for peer.",
"required": false,
"title": "Graceful Restart Mode"
},
"hold_down_timer": {
"default": 180,
"maximum": 65535,
"minimum": 1,
"required": false,
"title": "Wait period (seconds) before declaring peer dead",
"type": "integer"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"keep_alive_timer": {
"default": 60,
"maximum": 65535,
"minimum": 1,
"required": false,
"title": "Frequency (seconds) with which keep alive messages are sent to peers",
"type": "integer"
},
"logical_router_id": {
"readonly": true,
"required": false,
"title": "Logical router id",
"type": "string"
},
"maximum_hop_limit": {
"default": 1,
"description": "This value is set on TTL(time to live) of BGP header. When router receives the BGP packet, it decrements the TTL. The default value of TTL is one when BPG request is initiated.So in the case of a BGP peer multiple hops away and and value of TTL is one, then next router in the path will decrement the TTL to 0, realize it cant forward the packet and will drop it. If the hop count value to reach neighbor is equal to or less than the maximum_hop_limit value then intermediate router decrements the TTL count by one and forwards the request to BGP neighour. If the hop count value is greater than the maximum_hop_limit value then intermediate router discards the request when TTL becomes 0.",
"maximum": 255,
"minimum": 1,
"required": false,
"title": "Maximum Number of hops allowed to reach BGP neighbor",
"type": "int"
},
"neighbor_address": {
"$ref": "IPAddress,
"required": true,
"title": "Neighbor IP Address"
},
"password": {
"description": "User can create (POST) the neighbor with or without the password. The view (GET) on the neighbor, would never reveal if the password is set or not. The password can be set later using edit neighbor workFlow (PUT) On the edit neighbor (PUT), if the user does not specify the password property, the older value is retained. Maximum length of this field is 20 characters.",
"minLength": 1,
"required": false,
"sensitive": true,
"title": "Password",
"type": "string"
},
"remote_as": {
"deprecated": true,
"description": "This is a deprecated property, Please use 'remote_as_num' instead.",
"maximum": 4294967296,
"minimum": 1,
"required": false,
"title": "Autonomous System Number of the neighbor",
"type": "integer"
},
"remote_as_num": {
"required": false,
"title": "4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format",
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"source_address": {
"$ref": "IPAddress,
"deprecated": true,
"description": "Deprecated - do not provide a value for this field. Use source_addresses instead.",
"required": false,
"title": "Logical Router Uplink IP Address"
},
"source_addresses": {
"description": "BGP neighborship will be formed from all these source addresses to this neighbour.",
"items": {
"$ref": "IPAddress
},
"maxItems": 8,
"required": false,
"title": "Array of Logical Router Uplink IP Addresses",
"type": "array"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"type": "object"
}