Skip to content

Set Rule

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

Diagram
NameTypeConstraintMandatoryDefault Value
set_rulesList[set_rules]No

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
descriptionStringRegex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$No
community_modeChoiceappend, replaceNoappend
communityStringNo
tagIntegermin: 0, max: 4294967295No
weightIntegermin: 0, max: 65535No
next_hopIPNo
preferenceIntegermin: 0, max: 4294967295No
metricIntegermin: 0, max: 4294967295No
metric_typeChoiceospf-type1, ospf-type2No
dampeningClass[dampening]No
additional_communitiesList[additional_communities]No
set_as_pathsList[set_as_paths]No
next_hop_propagationBooleantrue, falseNofalse
multipathBooleantrue, falseNofalse
external_endpoint_groupClass[external_endpoint_group]No

dampening (apic.tenants.policies.set_rules)

Section titled “dampening (apic.tenants.policies.set_rules)”
NameTypeConstraintMandatoryDefault Value
half_lifeIntegermin: 1, max: 60No15
max_suppress_timeIntegermin: 1, max: 255No60
reuse_limitIntegermin: 1, max: 20000No750
suppress_limitIntegermin: 1, max: 20000No2000

additional_communities (apic.tenants.policies.set_rules)

Section titled “additional_communities (apic.tenants.policies.set_rules)”
NameTypeConstraintMandatoryDefault Value
communityStringYes
descriptionStringRegex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$No

set_as_paths (apic.tenants.policies.set_rules)

Section titled “set_as_paths (apic.tenants.policies.set_rules)”
NameTypeConstraintMandatoryDefault Value
criteriaChoiceprepend, prepend-last-asNoprepend
countIntegermin: 0, max: 10No0
asnsList[asns]No

external_endpoint_group (apic.tenants.policies.set_rules)

Section titled “external_endpoint_group (apic.tenants.policies.set_rules)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
l3outStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
tenantStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No

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

Section titled “asns (apic.tenants.policies.set_rules.set_as_paths)”
NameTypeConstraintMandatoryDefault Value
numberIntegerYes
orderIntegermin: 0, max: 31No0

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