Create Route Map (v2.3)

POST 
/v2.3/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/routing_routemaps

Create a route map.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

The ID of the site.

element_id stringrequired

The ID of the element.

application/json

Body

Details of the route map to be created

auto_generated boolean

The value true or false for auto-generated route map for an element.

description

The description of the route map. Max size = 1024.

id string

The ID of the route map.

name stringrequired

The name of the route map. Max size = 128.

route_map_entries RoutingRouteMapEntryV2N3[]
The details of the route map entries.
Array [
continue_entry string
To continue to use the rule that the route matches.
match RoutingRouteMapEntryMatchClause
The details of route match.
as_path_id string
As Path Id
community_list_id string
Community List Id
ip_next_hop_id string
Ip Next Hop Id
ip_prefix_list_id string
Ip Prefix List Id
metric int64
Metric
tag int32
Tag
order int32
Enter an order number from 1 to 65535 to define the order in which this route map will be used.
permit boolean
It allow routes to be advertised or Deny to block the routes from being advertised.
set RoutingRouteMapEntrySetClause
The details of the route map set.
additive_community boolean
Additive Community
as_path_prepend string
As Path Prepend
community string
Community
ip_next_hop string
Ip Next Hop
ip_v6_next_hop string
Ip V6 Next Hop
local_preference int64
Local Preference
metric int64
Metric
tag int32
Tag
type string
Possible values: [type-1, type-2]
Type
weight int64
Weight
]
tags string[]

A information field that can be added to identify the route map. Maximum 10 unique tags of length 1024 each are allowed.

used_for string

Possible values: [bgp, ospf]

Routing used for BGP or OSPF.

Responses

200

Successful Operation

application/json

Schema

Schema

auto_generated boolean

The value true or false for auto-generated route map for an element.

description

The description of the route map. Max size = 1024.

id string

The ID of the route map.

name stringrequired

The name of the route map. Max size = 128.

route_map_entries RoutingRouteMapEntryV2N3[]
The details of the route map entries.
Array [
continue_entry string
To continue to use the rule that the route matches.
match RoutingRouteMapEntryMatchClause
The details of route match.
as_path_id string
As Path Id
community_list_id string
Community List Id
ip_next_hop_id string
Ip Next Hop Id
ip_prefix_list_id string
Ip Prefix List Id
metric int64
Metric
tag int32
Tag
order int32
Enter an order number from 1 to 65535 to define the order in which this route map will be used.
permit boolean
It allow routes to be advertised or Deny to block the routes from being advertised.
set RoutingRouteMapEntrySetClause
The details of the route map set.
additive_community boolean
Additive Community
as_path_prepend string
As Path Prepend
community string
Community
ip_next_hop string
Ip Next Hop
ip_v6_next_hop string
Ip V6 Next Hop
local_preference int64
Local Preference
metric int64
Metric
tag int32
Tag
type string
Possible values: [type-1, type-2]
Type
weight int64
Weight
]
tags string[]

A information field that can be added to identify the route map. Maximum 10 unique tags of length 1024 each are allowed.

used_for string

Possible values: [bgp, ospf]

Routing used for BGP or OSPF.

Example (from schema)

{
  "auto_generated": true,
  "id": "string",
  "name": "string",
  "route_map_entries": [
    {
      "continue_entry": "string",
      "match": {
        "as_path_id": "string",
        "community_list_id": "string",
        "ip_next_hop_id": "string",
        "ip_prefix_list_id": "string",
        "metric": 0,
        "tag": 0
      },
      "order": 0,
      "permit": true,
      "set": {
        "additive_community": true,
        "as_path_prepend": "string",
        "community": "string",
        "ip_next_hop": "string",
        "ip_v6_next_hop": "string",
        "local_preference": 0,
        "metric": 0,
        "tag": 0,
        "type": "type-1",
        "weight": 0
      }
    }
  ],
  "tags": [
    "string"
  ],
  "used_for": "bgp"
}

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": "ELEMENT_NOT_FOUND"
      },
      {
        "code": "ELEMENT_NOT_ASSIGNED_TO_SITE"
      },
      {
        "code": "NOT_SUPPORTED_BY_ELEMENT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_SUPPORTED"
      },
      {
        "code": "ROUTE_MAP_ADDITIVE_COMMUNITY_NOT_ALLOWED_FOR_EMPTY_COMMUNITY"
      },
      {
        "code": "INVALID_ROUTE_MAP_NAME"
      },
      {
        "code": "MAX_LIMIT_ROUTE_MAP_ENTRIES_EXCEEDS"
      },
      {
        "code": "ROUTE_MAP_ENTRY_WITH_SAME_ORDER"
      },
      {
        "code": "ROUTE_MAP_ENTRY_INVALID_CONTINUE_ORDER"
      },
      {
        "code": "ROUTE_MAP_ENTRY_AS_PATH_NOT_FOUND"
      },
      {
        "code": "ROUTE_MAP_ENTRY_PREFIX_LIST_NOT_FOUND"
      },
      {
        "code": "ROUTE_MAP_ENTRY_COMMUNITY_LIST_NOT_FOUND"
      },
      {
        "code": "BGP_CONFIG_INVALID_AS_NUMBER"
      },
      {
        "code": "ROUTE_MAP_SET_CLAUSE_INVALID_NEXTHOP_IP"
      },
      {
        "code": "ROUTE_MAP_ENTRY_WITH_RESERVED_ORDER"
      }
    ]
  }
}

Loading...