Update BGP Config (v2.4)

PUT 
/v2.4/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/bgpconfigs/:bgp_config_id

Update the BGP configuration.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

The ID of the site.

element_id stringrequired

The ID of the element.

bgp_config_id stringrequired

The ID of the BGP config.

application/json

Body

Details of the bgp config to be updated

admin_distance int32

The BGP config admin distance. The device sets the default Admin Distance of all learned prefixes to 20. The admin value should be in the range 1-255.

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.

graceful_restart boolean

By default, graceful restart is Off. Change the default setting to On.

hold_time int32

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

id string

The BGP configuration ID.

ipv6_prefixes_to_adv_to_wan string[]

List of IPv6 prefixes advertised to WAN.

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. If the number entered is an A.B format, the web interface displays the corresponding 32-bit conversion below the entered value. If the number entered is a 32-bit format, the web interface displays the corresponding A.B value below the entered value. The Local AS Number is mandatory.

maximum_paths int32

The BGP config maximum paths. The max path value should be between 1 - 255. The default is 1.

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.

ospf_redistribution OspfRedistribution[]
Info on OSPF distribution.
Array [
route_map_id string
The route map ID.
vrf_context_id string
The VRF context ID.
]
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.

prefix_adv_type string

The type of prefix advertisement; Default, Unaggregated or Auto-aggregated.

prefix_adv_type_to_lan string

The prefix advertises to LAN.

prefixes_to_adv_to_wan string[]

The prefix advertises to WAN.

router_id string

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

stalepath_time int32

The stale path time for the BGP config. The stalepath time should be between 1 - 3600 seconds. The default is 120 seconds.

Responses

200

Successful Operation

application/json

Schema

Schema

admin_distance int32

The BGP config admin distance. The device sets the default Admin Distance of all learned prefixes to 20. The admin value should be in the range 1-255.

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.

graceful_restart boolean

By default, graceful restart is Off. Change the default setting to On.

hold_time int32

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

id string

The BGP configuration ID.

ipv6_prefixes_to_adv_to_wan string[]

List of IPv6 prefixes advertised to WAN.

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. If the number entered is an A.B format, the web interface displays the corresponding 32-bit conversion below the entered value. If the number entered is a 32-bit format, the web interface displays the corresponding A.B value below the entered value. The Local AS Number is mandatory.

maximum_paths int32

The BGP config maximum paths. The max path value should be between 1 - 255. The default is 1.

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.

ospf_redistribution OspfRedistribution[]
Info on OSPF distribution.
Array [
route_map_id string
The route map ID.
vrf_context_id string
The VRF context ID.
]
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.

prefix_adv_type string

The type of prefix advertisement; Default, Unaggregated or Auto-aggregated.

prefix_adv_type_to_lan string

The prefix advertises to LAN.

prefixes_to_adv_to_wan string[]

The prefix advertises to WAN.

router_id string

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

stalepath_time int32

The stale path time for the BGP config. The stalepath time should be between 1 - 3600 seconds. The default is 120 seconds.

Example (from schema)

{
  "admin_distance": 0,
  "adv_interval": 0,
  "graceful_restart": true,
  "hold_time": 0,
  "id": "string",
  "ipv6_prefixes_to_adv_to_wan": [
    "string"
  ],
  "keepalive_time": 0,
  "local_as_num": "string",
  "maximum_paths": 0,
  "md5_secret": "string",
  "multi_hop_limit": 0,
  "ospf_redistribution": [
    {
      "route_map_id": "string",
      "vrf_context_id": "string"
    }
  ],
  "peer_auth_type": "md5",
  "peer_retry_time": 0,
  "prefix_adv_type": "string",
  "prefix_adv_type_to_lan": "string",
  "prefixes_to_adv_to_wan": [
    "string"
  ],
  "router_id": "string",
  "stalepath_time": 0
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BGP_CONFIG_INVALID_LOCAL_AS_NUMBER"
      },
      {
        "code": "BGP_CONFIG_INVALID_KEEPALIVE_TIME"
      },
      {
        "code": "BGP_CONFIG_INVALID_HOLD_TIME"
      },
      {
        "code": "BGP_CONFIG_INVALID_ADV_INTERVAL"
      },
      {
        "code": "BGP_CONFIG_INVALID_PEER_RETRY_TIME"
      },
      {
        "code": "BGP_CONFIG_MD5_LENGTH_EXCEEDS"
      },
      {
        "code": "BGP_CONFIG_INVALID_MULTI_HOP_LIMIT"
      },
      {
        "code": "BGP_CONFIG_INVALID_HOLD_TIME_WITH_RESPECT_TO_KEEPALIVE_TIME"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      },
      {
        "code": "BGP_CONFIG_INVALID_PEER_AUTH_TYPE"
      },
      {
        "code": "BGP_CONFIG_INVALID_MD5_UNSET_REQUEST"
      }
    ]
  }
}

Loading...