Create Route Map (v2.2)

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

Create a route map.

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.

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 RoutingRouteMapEntryV2N2[]
The details of the route map entries.
Array [
continue_entry string
To continue to use the rule that the route matches.
match MatchClauses
The details of route match.
as_path_id string
The AS path ID.
community_list_id string
The community list ID.
ip_next_hop_id string
The IP next-hop ID.
ip_prefix_list_id string
The IP prefix list ID.
tag int32
A information field that can be added to identify the match clause.
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 SetClauses
The details of the route map set.
as_path_prepend string
The AS path prepend.
community string
The community.
ip_next_hop string
Ip Next Hop
local_preference int64
The local preference.
tag int32
A information field that can be added to identify the set clause.
weight int64
The weight of the set clause.
]
tags string[]

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

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 RoutingRouteMapEntryV2N2[]
The details of the route map entries.
Array [
continue_entry string
To continue to use the rule that the route matches.
match MatchClauses
The details of route match.
as_path_id string
The AS path ID.
community_list_id string
The community list ID.
ip_next_hop_id string
The IP next-hop ID.
ip_prefix_list_id string
The IP prefix list ID.
tag int32
A information field that can be added to identify the match clause.
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 SetClauses
The details of the route map set.
as_path_prepend string
The AS path prepend.
community string
The community.
ip_next_hop string
Ip Next Hop
local_preference int64
The local preference.
tag int32
A information field that can be added to identify the set clause.
weight int64
The weight of the set clause.
]
tags string[]

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

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",
        "tag": 0
      },
      "order": 0,
      "permit": true,
      "set": {
        "as_path_prepend": "string",
        "community": "string",
        "ip_next_hop": "string",
        "local_preference": 0,
        "tag": 0,
        "weight": 0
      }
    }
  ],
  "tags": [
    "string"
  ]
}

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...