Skip to main content

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.

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

Successful Operation

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.

Loading...