{
"additionalProperties": false,
"description": "Contains information necessary to configure a BGP neighbor.",
"extends": {
"$ref": "PolicyConfigResource
},
"id": "BgpNeighborConfig",
"module_id": "PolicyConnectivity",
"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"
},
"allow_as_in": {
"default": false,
"required": false,
"title": "Flag to enable allowas_in option for BGP neighbor",
"type": "boolean"
},
"bfd": {
"$ref": "BgpBfdConfig,
"description": "BFD configuration for failure detection. BFD is enabled with default values when not configured.",
"title": "BFD configuration for failure detection"
},
"children": {
"description": "subtree for this type within policy tree containing nested elements.",
"items": {
"$ref": "ChildPolicyConfigResource
},
"required": false,
"title": "subtree for this type within policy tree",
"type": "array"
},
"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"
},
"graceful_restart_mode": {
"description": "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.",
"enum": [
"DISABLE",
"GR_AND_HELPER",
"HELPER_ONLY"
],
"title": "BGP Graceful Restart Configuration Mode",
"type": "string"
},
"hold_down_time": {
"default": 180,
"description": "Wait time in seconds before declaring peer dead.",
"maximum": 65535,
"minimum": 1,
"title": "Wait time in seconds before declaring peer dead",
"type": "int"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"in_route_filters": {
"deprecated": true,
"description": "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.",
"items": {
"type": "string"
},
"maxItems": 1,
"required": false,
"title": "Prefix-list or route map path for IN direction",
"type": "array"
},
"keep_alive_time": {
"default": 60,
"description": "Interval (in seconds) between keep alive messages sent to peer.",
"maximum": 65535,
"minimum": 1,
"title": "Interval between keep alive messages sent to peer",
"type": "int"
},
"marked_for_delete": {
"default": false,
"description": "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.",
"readonly": true,
"required": false,
"title": "Indicates whether the intent object is marked for deletion",
"type": "boolean"
},
"maximum_hop_limit": {
"default": 1,
"description": "Maximum number of hops allowed to reach BGP neighbor.",
"maximum": 255,
"minimum": 1,
"title": "Maximum number of hops allowed to reach BGP neighbor",
"type": "int"
},
"neighbor_address": {
"$ref": "IPAddress,
"required": true,
"title": "Neighbor IP Address"
},
"out_route_filters": {
"deprecated": true,
"description": "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.",
"items": {
"type": "string"
},
"maxItems": 1,
"required": false,
"title": "Prefix-list or route map path for OUT direction",
"type": "array"
},
"overridden": {
"default": false,
"description": "Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.",
"readonly": true,
"required": false,
"title": "Indicates whether this object is the overridden intent object",
"type": "boolean"
},
"parent_path": {
"description": "Path of its parent",
"readonly": true,
"required": false,
"title": "Path of its parent",
"type": "string"
},
"password": {
"description": "Specify password for BGP neighbor authentication. Empty string (\"\") clears existing password.",
"maxLength": 20,
"minLength": 0,
"sensitive": true,
"title": "Password",
"type": "string"
},
"path": {
"description": "Absolute path of this object",
"readonly": true,
"required": false,
"title": "Absolute path of this object",
"type": "string"
},
"relative_path": {
"description": "Path relative from its parent",
"readonly": true,
"required": false,
"title": "Relative path of this object",
"type": "string"
},
"remote_as_num": {
"required": true,
"title": "4 Byte ASN of the neighbor in ASPLAIN Format",
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"route_filtering": {
"description": "Enable address families and route filtering in each direction.",
"items": {
"$ref": "BgpRouteFiltering
},
"maxItems": 2,
"required": false,
"title": "Enable address families and route filtering in each direction",
"type": "array"
},
"source_addresses": {
"description": "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.",
"items": {
"$ref": "IPAddress
},
"maxItems": 8,
"required": false,
"title": "Source IP Addresses for BGP peering",
"type": "array"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"unique_id": {
"description": "This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system",
"type": "string"
}
},
"title": "BGP neighbor config",
"type": "object"
}