Skip to content

Service Route Policy Definition

Version:

Configure route policies that can be assigned to routing protocols or when advertising routing protocols to OMP.

Diagram

Diagram

Classes

service_profiles (sdwan.feature_profiles)

Name	Type	Constraint	Mandatory	Default Value
route_policies	List	`[route_policies]`	No

route_policies (sdwan.feature_profiles.service_profiles)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[^&<>! "]{1,128}$`	No
description	String		No
default_action	Choice	`accept`, `reject`	Yes
sequences	List	`[sequences]`	No

sequences (sdwan.feature_profiles.service_profiles.route_policies)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `65536`	Yes
name	String	min: `1`, max: `19`	No	`route`
base_action	Choice	`accept`, `reject`	Yes
protocol	Choice	`ipv4`, `ipv6`, `both`	No	`ipv4`
match_entries	Class	`[match_entries]`	No
actions	Class	`[actions]`	No

match_entries (sdwan.feature_profiles.service_profiles.route_policies.sequences)

Name	Type	Constraint	Mandatory	Default Value
as_path_list	String	Regex: `^[^&<>! "]{1,128}$`	No
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
expanded_community_list	String	Regex: `^[^&<>! "]{1,128}$`	No
extended_community_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv4_address_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv4_next_hop_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv6_address_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv6_next_hop_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
metric	Integer	min: `0`, max: `4294967295`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
standard_community_lists	List	String[Regex: `^[^&<>! "]{1,128}$`]	No
standard_community_lists_criteria	Choice	`or`, `and`, `exact`	No

actions (sdwan.feature_profiles.service_profiles.route_policies.sequences)

Name	Type	Constraint	Mandatory	Default Value
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
communities	List	Choice[`internet`, `local-AS`, `no-advertise`, `no-export`]	No
communities_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
communities_additive	Boolean	`true`, `false`	No
ipv4_next_hop	IP		No
ipv6_next_hop	IP		No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`type1`, `type2`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`igp`, `egp`, `incomplete`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
prepend_as_paths	List	Integer[min: `1`, max: `4294967295`]	No
weight	Integer	min: `0`, max: `65535`	No

Examples

Example-1: This example demonstrates how to configure a service route policy feature that accepts and assigns metric 200 to all prefixes that have OSPF tag 10. All other prefixes are accepted with the default action.

sdwan:
  feature_profiles:
    service_profiles:
      - name: service1
        route_policies:
          - name: route_policy_set_metric
            description: "Set metric for OSPF routes"
            default_action: accept
            sequences:
              - id: 1
                base_action: accept
                match_entries:
                  ospf_tag: 10
                actions:
                  metric: 200

Configure route policies that can be assigned to routing protocols or when advertising routing protocols to OMP.

Diagram

Diagram

Classes

service_profiles (sdwan.feature_profiles)

Name	Type	Constraint	Mandatory	Default Value
route_policies	List	`[route_policies]`	No

route_policies (sdwan.feature_profiles.service_profiles)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[^&<>! "]{1,128}$`	No
description	String		No
default_action	Choice	`accept`, `reject`	Yes
sequences	List	`[sequences]`	No

sequences (sdwan.feature_profiles.service_profiles.route_policies)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `65536`	Yes
name	String	min: `1`, max: `19`	No	`route`
base_action	Choice	`accept`, `reject`	Yes
protocol	Choice	`ipv4`, `ipv6`, `both`	No	`ipv4`
match_entries	Class	`[match_entries]`	No
actions	Class	`[actions]`	No

match_entries (sdwan.feature_profiles.service_profiles.route_policies.sequences)

Name	Type	Constraint	Mandatory	Default Value
as_path_list	String	Regex: `^[^&<>! "]{1,128}$`	No
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
expanded_community_list	String	Regex: `^[^&<>! "]{1,128}$`	No
extended_community_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv4_address_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv4_next_hop_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv6_address_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv6_next_hop_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
metric	Integer	min: `0`, max: `4294967295`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
standard_community_lists	List	String[Regex: `^[^&<>! "]{1,128}$`]	No
standard_community_lists_criteria	Choice	`or`, `and`, `exact`	No

actions (sdwan.feature_profiles.service_profiles.route_policies.sequences)

Name	Type	Constraint	Mandatory	Default Value
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
communities	List	Choice[`internet`, `local-AS`, `no-advertise`, `no-export`]	No
communities_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
communities_additive	Boolean	`true`, `false`	No
ipv4_next_hop	IP		No
ipv6_next_hop	IP		No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`type1`, `type2`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`igp`, `egp`, `incomplete`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
prepend_as_paths	List	Integer[min: `1`, max: `4294967295`]	No
weight	Integer	min: `0`, max: `65535`	No

Examples

Example-1: This example demonstrates how to configure a service route policy feature that accepts and assigns metric 200 to all prefixes that have OSPF tag 10. All other prefixes are accepted with the default action.

sdwan:
  feature_profiles:
    service_profiles:
      - name: service1
        route_policies:
          - name: route_policy_set_metric
            description: "Set metric for OSPF routes"
            default_action: accept
            sequences:
              - id: 1
                base_action: accept
                match_entries:
                  ospf_tag: 10
                actions:
                  metric: 200

Configure route policies that can be assigned to routing protocols or when advertising routing protocols to OMP.

Diagram

Diagram

Classes

service_profiles (sdwan.feature_profiles)

Name	Type	Constraint	Mandatory	Default Value
route_policies	List	`[route_policies]`	No

route_policies (sdwan.feature_profiles.service_profiles)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[^&<>! "]{1,128}$`	No
description	String		No
default_action	Choice	`accept`, `reject`	Yes
sequences	List	`[sequences]`	No

sequences (sdwan.feature_profiles.service_profiles.route_policies)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `65536`	Yes
name	String	min: `1`, max: `19`	No	`route`
base_action	Choice	`accept`, `reject`	Yes
protocol	Choice	`ipv4`, `ipv6`, `both`	No	`ipv4`
match_entries	Class	`[match_entries]`	No
actions	Class	`[actions]`	No

match_entries (sdwan.feature_profiles.service_profiles.route_policies.sequences)

Name	Type	Constraint	Mandatory	Default Value
as_path_list	String	Regex: `^[^&<>! "]{1,128}$`	No
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
expanded_community_list	String	Regex: `^[^&<>! "]{1,128}$`	No
extended_community_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv4_address_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv4_next_hop_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv6_address_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
ipv6_next_hop_prefix_list	String	Regex: `^[^&<>! "]{1,128}$`	No
metric	Integer	min: `0`, max: `4294967295`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
standard_community_lists	List	String[Regex: `^[^&<>! "]{1,128}$`]	No
standard_community_lists_criteria	Choice	`or`, `and`, `exact`	No

actions (sdwan.feature_profiles.service_profiles.route_policies.sequences)

Name	Type	Constraint	Mandatory	Default Value
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
communities	List	Choice[`internet`, `local-AS`, `no-advertise`, `no-export`]	No
communities_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
communities_additive	Boolean	`true`, `false`	No
ipv4_next_hop	IP		No
ipv6_next_hop	IP		No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`type1`, `type2`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`igp`, `egp`, `incomplete`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
prepend_as_paths	List	Integer[min: `1`, max: `4294967295`]	No
weight	Integer	min: `0`, max: `65535`	No

Examples

Example-1: This example demonstrates how to configure a service route policy feature that accepts and assigns metric 200 to all prefixes that have OSPF tag 10. All other prefixes are accepted with the default action.

sdwan:
  feature_profiles:
    service_profiles:
      - name: service1
        route_policies:
          - name: route_policy_set_metric
            description: "Set metric for OSPF routes"
            default_action: accept
            sequences:
              - id: 1
                base_action: accept
                match_entries:
                  ospf_tag: 10
                actions:
                  metric: 200