Route Policy Definition

Version:

Configure route policies.

Diagram

Classes

definitions (sdwan.localized_policies)

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

route_policies (sdwan.localized_policies.definitions)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	Yes
description	String		Yes
default_action	Choice	`accept`, `reject`	Yes
sequences	List	`[sequences]`	No

sequences (sdwan.localized_policies.definitions.route_policies)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `65534`	Yes
name	String		No	`Route`
ip_type	Choice	`ipv4`, `ipv6`, `both`	No	`ipv4`
base_action	Choice	`accept`, `reject`	Yes
match_criterias	Class	`[match_criterias]`	No
actions	Class	`[actions]`	No

match_criterias (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
as_path_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
expanded_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
expanded_community_list_variable	String		No
extended_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
metric	Integer	min: `0`, max: `4294967295`	No
next_hop_prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
peer	IP		No
prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
standard_community_lists	List	String[Regex: `^[A-Za-z0-9-_]{1,128}$`]	No
standard_community_lists_criteria	Choice	`or`, `and`, `exact`	No

actions (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
aggregator	Integer	min: `0`, max: `4294967295`	No
aggregator_ip	IP		No
atomic_aggregate	Boolean	`true`, `false`	No
communities	List	Any[Integer[min: `0`, max: `4294967295`] or String[Regex: `^[0-9]{1,5}(:)[0-9]{1,5}$`] or Choice[`internet`, `local-AS`, `no-advertise`, `no-export`]]	No
community_variable	String		No
community_additive	Boolean	`true`, `false`	No
exclude_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
local_preference	Integer	min: `0`, max: `4294967295`	No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`type1`, `type2`	No
next_hop	IP		No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
originator	IP		No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
prepend_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
weight	Integer	min: `0`, max: `4294967295`	No

Examples

sdwan:
  localized_policies:
    definitions:
      route_policies:
        - name: ROUTE-MAP-SET-OMPTAG
          description: "Set OMP tag based on community list"
          default_action: accept
          sequences:
            - id: 10
              ip_type: ipv4
              base_action: accept
              match_criterias:
                standard_community_lists:
                  - COMMUNITY-LIST-REGION1
                  - COMMUNITY-LIST-REGION2
                standard_community_lists_criteria: or
              actions:
                omp_tag: 12345

Configure route policies.

Diagram

Classes

definitions (sdwan.localized_policies)

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

route_policies (sdwan.localized_policies.definitions)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	Yes
description	String		Yes
default_action	Choice	`accept`, `reject`	Yes
sequences	List	`[sequences]`	No

sequences (sdwan.localized_policies.definitions.route_policies)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `65534`	Yes
name	String		No	`Route`
ip_type	Choice	`ipv4`, `ipv6`, `both`	No	`ipv4`
base_action	Choice	`accept`, `reject`	Yes
match_criterias	Class	`[match_criterias]`	No
actions	Class	`[actions]`	No

match_criterias (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
as_path_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
expanded_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
expanded_community_list_variable	String		No
extended_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
metric	Integer	min: `0`, max: `4294967295`	No
next_hop_prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
peer	IP		No
prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
standard_community_lists	List	String[Regex: `^[A-Za-z0-9-_]{1,128}$`]	No
standard_community_lists_criteria	Choice	`or`, `and`, `exact`	No

actions (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
aggregator	Integer	min: `0`, max: `4294967295`	No
aggregator_ip	IP		No
atomic_aggregate	Boolean	`true`, `false`	No
communities	List	Any[Integer[min: `0`, max: `4294967295`] or String[Regex: `^[0-9]{1,5}(:)[0-9]{1,5}$`] or Choice[`internet`, `local-AS`, `no-advertise`, `no-export`]]	No
community_variable	String		No
community_additive	Boolean	`true`, `false`	No
exclude_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
local_preference	Integer	min: `0`, max: `4294967295`	No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`type1`, `type2`	No
next_hop	IP		No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
originator	IP		No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
prepend_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
weight	Integer	min: `0`, max: `4294967295`	No

Examples

sdwan:
  localized_policies:
    definitions:
      route_policies:
        - name: ROUTE-MAP-SET-OMPTAG
          description: "Set OMP tag based on community list"
          default_action: accept
          sequences:
            - id: 10
              ip_type: ipv4
              base_action: accept
              match_criterias:
                standard_community_lists:
                  - COMMUNITY-LIST-REGION1
                  - COMMUNITY-LIST-REGION2
                standard_community_lists_criteria: or
              actions:
                omp_tag: 12345

Configure route policies.

Diagram

Classes

definitions (sdwan.localized_policies)

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

route_policies (sdwan.localized_policies.definitions)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	Yes
description	String		Yes
default_action	Choice	`accept`, `reject`	Yes
sequences	List	`[sequences]`	No

sequences (sdwan.localized_policies.definitions.route_policies)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `65534`	Yes
name	String		No
ip_type	Choice	`ipv4`, `ipv6`, `both`	No	`ipv4`
base_action	Choice	`accept`, `reject`	Yes
match_criterias	Class	`[match_criterias]`	No
actions	Class	`[actions]`	No

match_criterias (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
as_path_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
expanded_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
expanded_community_list_variable	String		No
extended_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
metric	Integer	min: `0`, max: `4294967295`	No
next_hop_prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
peer	IP		No
prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
standard_community_lists	List	String[Regex: `^[A-Za-z0-9-_]{1,128}$`]	No
standard_community_lists_criteria	Choice	`or`, `and`, `exact`	No

actions (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
aggregator	Integer	min: `0`, max: `4294967295`	No
aggregator_ip	IP		No
atomic_aggregate	Boolean	`true`, `false`	No
communities	List	Any[Integer[min: `0`, max: `4294967295`] or String[Regex: `^[0-9]{1,5}(:)[0-9]{1,5}$`] or Choice[`internet`, `local-AS`, `no-advertise`, `no-export`]]	No
community_variable	String		No
community_additive	Boolean	`true`, `false`	No
exclude_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
local_preference	Integer	min: `0`, max: `4294967295`	No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`type1`, `type2`	No
next_hop	IP		No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
originator	IP		No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
prepend_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
weight	Integer	min: `0`, max: `4294967295`	No

Examples

sdwan:
  localized_policies:
    definitions:
      route_policies:
        - name: ROUTE-MAP-SET-OMPTAG
          description: "Set OMP tag based on community list"
          default_action: accept
          sequences:
            - id: 10
              ip_type: ipv4
              base_action: accept
              match_criterias:
                standard_community_lists:
                  - COMMUNITY-LIST-REGION1
                  - COMMUNITY-LIST-REGION2
                standard_community_lists_criteria: or
              actions:
                omp_tag: 12345

Configure route policies.

Diagram

Classes

definitions (sdwan.localized_policies)

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

route_policies (sdwan.localized_policies.definitions)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	Yes
description	String		Yes
default_action	Choice	`accept`, `reject`	Yes
sequences	List	`[sequences]`	No

sequences (sdwan.localized_policies.definitions.route_policies)

Name	Type	Constraint	Mandatory
id	Integer	min: `1`, max: `65534`	Yes
name	String		No
ip_type	Choice	`ipv4`, `ipv6`, `both`	Yes
base_action	Choice	`accept`, `reject`	Yes
match_criterias	Class	`[match_criterias]`	No
actions	Class	`[actions]`	No

match_criterias (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
as_path_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
expanded_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
extended_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
metric	Integer	min: `0`, max: `4294967295`	No
next_hop_prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
peer	IP		No
prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
standard_community_lists	List	String[Regex: `^[A-Za-z0-9-_]{1,128}$`]	No
standard_community_lists_criteria	Choice	`or`, `and`, `exact`	No

actions (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
aggregator	Integer	min: `0`, max: `4294967295`	No
aggregator_ip	IP		No
atomic_aggregate	Boolean	`true`, `false`	No
communities	List	Any[Integer[min: `0`, max: `4294967295`] or String[Regex: `^[0-9]{1,5}(:)[0-9]{1,5}$`] or Choice[`internet`, `local-AS`]]	No
community_additive	Boolean	`true`, `false`	No
exclude_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
local_preference	Integer	min: `0`, max: `4294967295`	No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`type1`, `type2`	No
next_hop	IP		No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
originator	IP		No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
prepend_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
weight	Integer	min: `0`, max: `4294967295`	No

Examples

sdwan:
  localized_policies:
    definitions:
      route_policies:
        - name: ROUTE-MAP-SET-OMPTAG
          description: "Set OMP tag based on community list"
          default_action: accept
          sequences:
            - id: 10
              ip_type: ipv4
              base_action: accept
              match_criterias:
                standard_community_lists:
                  - COMMUNITY-LIST-REGION1
                  - COMMUNITY-LIST-REGION2
                standard_community_lists_criteria: or
              actions:
                omp_tag: 12345

Configure route policies.

Diagram

Classes

definitions (sdwan.localized_policies)

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

route_policies (sdwan.localized_policies.definitions)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	Yes
description	String		Yes
default_action	Choice	`accept`, `reject`	Yes
sequences	List	`[sequences]`	No

sequences (sdwan.localized_policies.definitions.route_policies)

Name	Type	Constraint	Mandatory
id	Integer	min: `1`, max: `65534`	Yes
name	String		No
ip_type	Choice	`ipv4`, `ipv6`, `both`	Yes
base_action	Choice	`accept`, `reject`	Yes
match_criterias	Class	`[match_criterias]`	No
actions	Class	`[actions]`	No

match_criterias (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
as_path_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
bgp_local_preference	Integer	min: `0`, max: `4294967295`	No
expanded_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
extended_community_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
metric	Integer	min: `0`, max: `4294967295`	No
next_hop_prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
peer	IP		No
prefix_list	String	Regex: `^[A-Za-z0-9-_]{1,128}$`	No
standard_community_lists	List	String[Regex: `^[A-Za-z0-9-_]{1,128}$`]	No
standard_community_lists_criteria	Choice	`or`, `and`, `exact`	No

actions (sdwan.localized_policies.definitions.route_policies.sequences)

Name	Type	Constraint	Mandatory
aggregator	Integer	min: `0`, max: `4294967295`	No
aggregator_ip	IP		No
atomic_aggregate	Boolean	`true`, `false`	No
communities	List	Any[Integer[min: `0`, max: `4294967295`] or String[Regex: `^[0-9]{1,5}(:)[0-9]{1,5}$`] or Choice[`internet`, `local-AS`]]	No
community_additive	Boolean	`true`, `false`	No
exclude_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
local_preference	Integer	min: `0`, max: `4294967295`	No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`type1`, `type2`	No
next_hop	IP		No
omp_tag	Integer	min: `0`, max: `4294967295`	No
origin	Choice	`egp`, `igp`, `incomplete`	No
originator	IP		No
ospf_tag	Integer	min: `0`, max: `4294967295`	No
prepend_as_paths	List	Integer[min: `0`, max: `4294967295`]	No
weight	Integer	min: `0`, max: `4294967295`	No

Examples

sdwan:
  localized_policies:
    definitions:
      route_policies:
        - name: ROUTE-MAP-SET-OMPTAG
          description: "Set OMP tag based on community list"
          default_action: accept
          sequences:
            - id: 10
              ip_type: ipv4
              base_action: accept
              match_criterias:
                standard_community_lists:
                  - COMMUNITY-LIST-REGION1
                  - COMMUNITY-LIST-REGION2
                standard_community_lists_criteria: or
              actions:
                omp_tag: 12345