Set Rule

Version:

Location in GUI: Tenants » XXX » Policies » Protocol » Set Rules

Diagram

Classes

policies (apic.tenants)

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

set_rules (apic.tenants.policies)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
community_mode	Choice	`append`, `replace`	No	`append`
community	String		No
tag	Integer	min: `0`, max: `4294967295`	No
weight	Integer	min: `0`, max: `65535`	No
next_hop	IP		No
preference	Integer	min: `0`, max: `4294967295`	No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`ospf-type1`, `ospf-type2`	No
dampening	Class	`[dampening]`	No
additional_communities	List	`[additional_communities]`	No
set_as_paths	List	`[set_as_paths]`	No
next_hop_propagation	Boolean	`true`, `false`	No	`false`
multipath	Boolean	`true`, `false`	No	`false`
external_endpoint_group	Class	`[external_endpoint_group]`	No

dampening (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
half_life	Integer	min: `1`, max: `60`	No	`15`
max_suppress_time	Integer	min: `1`, max: `255`	No	`60`
reuse_limit	Integer	min: `1`, max: `20000`	No	`750`
suppress_limit	Integer	min: `1`, max: `20000`	No	`2000`

additional_communities (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
community	String		Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No

set_as_paths (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
criteria	Choice	`prepend`, `prepend-last-as`	No	`prepend`
count	Integer	min: `0`, max: `10`	No	0
asns	List	`[asns]`	No

external_endpoint_group (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
l3out	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

asns (apic.tenants.policies.set_rules.set_as_paths)

Name	Type	Constraint	Mandatory	Default Value
number	Integer		Yes
order	Integer	min: `0`, max: `31`	No	0

Examples

Example 1: The YAML snippet below demonstrates the set_as_paths functionality, designed to append multiple Autonomous Systems (ASs) to the AS_PATH of a BGP prefix. This is a key feature for BGP AS Path manipulation. The set_as_paths alongside the asns are defined as list.

apic:
  tenants:
    - name: TN_01
      policies:
        set_rules:
          - name: SET_STG_STG_L_65002:10002
            community: regular:as2-nn2:65002:10002
            set_as_paths:
              - criteria: prepend
                asns:
                  - number: 65098
                    order: 1
                  - number: 65098
                    order: 2
                  - number: 65098
                    order: 3
              - criteria: prepend-last-as
                count: 8

Example 2: The YAML snippet below demonstrates the set_as_path functionality designed to address dynamic EPG classification. The external_endpoint_group is used to specify the external EPG to which the traffic would be classified.

apic:
  tenants:
    - name: TN_01
      policies:
        set_rules:
          - name: set-extEPG
            external_endpoint_group:
              name: default_extepg
              l3out: default
              tenant: common

Location in GUI: Tenants » XXX » Policies » Protocol » Set Rules

Diagram

Classes

policies (apic.tenants)

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

set_rules (apic.tenants.policies)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
community_mode	Choice	`append`, `replace`	No	`append`
community	String		No
tag	Integer	min: `0`, max: `4294967295`	No
weight	Integer	min: `0`, max: `65535`	No
next_hop	IP		No
preference	Integer	min: `0`, max: `4294967295`	No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`ospf-type1`, `ospf-type2`	No
dampening	Class	`[dampening]`	No
additional_communities	List	`[additional_communities]`	No
set_as_paths	List	`[set_as_paths]`	No
next_hop_propagation	Boolean	`true`, `false`	No	`false`
multipath	Boolean	`true`, `false`	No	`false`
external_endpoint_group	Class	`[external_endpoint_group]`	No

dampening (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
half_life	Integer	min: `1`, max: `60`	No	`15`
max_suppress_time	Integer	min: `1`, max: `255`	No	`60`
reuse_limit	Integer	min: `1`, max: `20000`	No	`750`
suppress_limit	Integer	min: `1`, max: `20000`	No	`2000`

additional_communities (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
community	String		Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No

set_as_paths (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
criteria	Choice	`prepend`, `prepend-last-as`	No	`prepend`
count	Integer	min: `0`, max: `10`	No	0
asns	List	`[asns]`	No

external_endpoint_group (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
l3out	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

asns (apic.tenants.policies.set_rules.set_as_paths)

Name	Type	Constraint	Mandatory	Default Value
number	Integer		Yes
order	Integer	min: `0`, max: `31`	No	0

Examples

apic:
  tenants:
    - name: ABC
      policies:
        set_rules:
          - name: SET1
            description: desc1
            community_mode: replace
            community: regular:as2-nn2:12:123

Set AS Path

apic:
  tenants:
    - name: ABC
      policies:
        set_rules:
          - name: SET1
            description: desc1
            community_mode: replace
            community: regular:as2-nn2:12:123
            set_as_paths:
              - criteria: "prepend"
                asns:
                  - number: 65098
                    order: 1
                  - number: 65098
                    order: 2
                  - number: 65098
                    order: 3
              - criteria: "prepend-last-as"
                count: 8

Location in GUI: Tenants » XXX » Policies » Protocol » Set Rules

Diagram

Classes

policies (apic.tenants)

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

set_rules (apic.tenants.policies)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
community_mode	Choice	`append`, `replace`	No	`append`
community	String		No
tag	Integer	min: `0`, max: `4294967295`	No
weight	Integer	min: `0`, max: `65535`	No
next_hop	IP		No
preference	Integer	min: `0`, max: `4294967295`	No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`ospf-type1`, `ospf-type2`	No
dampening	Class	`[dampening]`	No
additional_communities	List	`[additional_communities]`	No
set_as_paths	List	`[set_as_paths]`	No
next_hop_propagation	Boolean	`true`, `false`	No	`false`
multipath	Boolean	`true`, `false`	No	`false`
external_endpoint_group	Class	`[external_endpoint_group]`	No

dampening (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
half_life	Integer	min: `1`, max: `60`	No	`15`
max_suppress_time	Integer	min: `1`, max: `255`	No	`60`
reuse_limit	Integer	min: `1`, max: `20000`	No	`750`
suppress_limit	Integer	min: `1`, max: `20000`	No	`2000`

additional_communities (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
community	String		Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No

set_as_paths (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
criteria	Choice	`prepend`, `prepend-last-as`	No	`prepend`
count	Integer	min: `0`, max: `10`	No	0
asns	List	`[asns]`	No

external_endpoint_group (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
l3out	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

asns (apic.tenants.policies.set_rules.set_as_paths)

Name	Type	Constraint	Mandatory	Default Value
number	Integer		Yes
order	Integer	min: `0`, max: `31`	No	0

Examples

apic:
  tenants:
    - name: ABC
      policies:
        set_rules:
          - name: SET1
            description: desc1
            community_mode: replace
            community: regular:as2-nn2:12:123

Set AS Path

apic:
  tenants:
    - name: ABC
      policies:
        set_rules:
          - name: SET1
            description: desc1
            community_mode: replace
            community: regular:as2-nn2:12:123
            set_as_paths:
              - criteria: "prepend"
                asns:
                  - number: 65098
                    order: 1
                  - number: 65098
                    order: 2
                  - number: 65098
                    order: 3
              - criteria: "prepend-last-as"
                count: 8

Location in GUI: Tenants » XXX » Policies » Protocol » Set Rules

Diagram

Classes

policies (apic.tenants)

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

set_rules (apic.tenants.policies)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
community_mode	Choice	`append`, `replace`	No	`append`
community	String		No
tag	Integer	min: `0`, max: `4294967295`	No
weight	Integer	min: `0`, max: `65535`	No
next_hop	IP		No
preference	Integer	min: `0`, max: `4294967295`	No
metric	Integer	min: `0`, max: `4294967295`	No
metric_type	Choice	`ospf-type1`, `ospf-type2`	No
dampening	Class	`[dampening]`	No
additional_communities	List	`[additional_communities]`	No
set_as_paths	List	`[set_as_paths]`	No
next_hop_propagation	Boolean		No	`false`
multipath	Boolean		No	`false`
external_endpoint_group	Class	`[external_endpoint_group]`	No

dampening (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
half_life	Integer	min: `1`, max: `60`	No	`15`
max_suppress_time	Integer	min: `1`, max: `255`	No	`60`
reuse_limit	Integer	min: `1`, max: `20000`	No	`750`
suppress_limit	Integer	min: `1`, max: `20000`	No	`2000`

additional_communities (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
community	String		Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No

set_as_paths (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory	Default Value
criteria	Choice	`prepend`, `prepend-last-as`	No	`prepend`
count	Integer	min: `0`, max: `10`	No	0
asns	List	`[asns]`	No

external_endpoint_group (apic.tenants.policies.set_rules)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
l3out	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

asns (apic.tenants.policies.set_rules.set_as_paths)

Name	Type	Constraint	Mandatory	Default Value
number	Integer		Yes
order	Integer	min: `0`, max: `31`	No	0

Examples

apic:
  tenants:
    - name: ABC
      policies:
        set_rules:
          - name: SET1
            description: desc1
            community_mode: replace
            community: regular:as2-nn2:12:123

Set AS Path

apic:
  tenants:
    - name: ABC
      policies:
        set_rules:
          - name: SET1
            description: desc1
            community_mode: replace
            community: regular:as2-nn2:12:123
            set_as_paths:
              - criteria: "prepend"
                asns:
                  - number: 65098
                    order: 1
                  - number: 65098
                    order: 2
                  - number: 65098
                    order: 3
              - criteria: "prepend-last-as"
                count: 8