The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Description: Specify multihop TTL for remote peer
Syntax:
<1-255> |
EBGP TTL value. Number range from=1 to=255 |
Command Mode: neighbor : Configure a BGP neighbor
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# router bgp <fabric-ASN> (config-bgp)# vrf member tenant <WORD> vrf <WORD> (config-leaf-bgp-vrf)# neighbor A.B.C.D|A.B.C.D/LEN|A:B::C:D|A:B::C:D/LEN [l3out <WORD>] (config-leaf-bgp-vrf-neighbor)# ebgp-multihop <NUMBER>
Description: Configure BFD ECHO-SRC-ADDRESS value
Syntax:
arg |
Command Mode: template bfd : BFD group of commands
Command Path:
# configure [['terminal', 't']] (config)# template bfd ip|ipv6 <WORD> (config-bfd)# echo-address <>
Description: Enable Echo mode
Syntax:
enable |
Enable Echo mode |
Command Mode: template bfd : Configure BFD Interface Policy Templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template bfd <WORD> tenant <WORD> (config-template-bfd-pol)# echo-mode enable
Description: Configure BFD ECHO-RX-INTERVAL value in milliseconds
Syntax:
<interval> |
BFD interval. Number range from=50 to=999 |
Command Mode: template bfd : BFD group of commands
Command Path:
# configure [['terminal', 't']] (config)# template bfd ip|ipv6 <WORD> (config-bfd)# echo-rx-interval <NUMBER>
Description: Configure Echo Rx Interval in milliseconds
Syntax:
<interval> |
Echo Rx Interval. Number range from=50 to=999 |
Command Mode: template bfd : Configure BFD Interface Policy Templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template bfd <WORD> tenant <WORD> (config-template-bfd-pol)# echo-rx-interval <NUMBER>
Description: Configure the e-mail address
Syntax:
WORD |
The email address (Max Size None) |
Command Mode: destination : Configure destination Parameters
Command Path:
# configure [['terminal', 't']] (config)# callhome common (config-callhome)# destination-profile (config-callhome-destnprof)# destination <WORD> (config-callhome-destnprof-destn)# email-addr <WORD>
Description: The contact e-mail address
Syntax:
WORD |
Contract e-mail address (Max Size 512) |
Command Mode: destination-profile : Configure destination profile Parameters
Command Path:
# configure [['terminal', 't']] (config)# callhome common (config-callhome)# destination-profile (config-callhome-destnprof)# email-contact <WORD>
Description: Set The email address of the locally-authenticated user.
Syntax:
WORD |
email address of the locally-authenticated user |
Command Mode: username : Create a locally-authenticated user account
Command Path:
# configure [['terminal', 't']] (config)# username <WORD> (config-username)# email <WORD>
Description: Set The email address of the organization contact person.
Syntax:
<WORD> |
email address (Max Size 40) |
Command Mode: csr : A csr mode to create and hold an SSL certificate
Command Path:
# configure [['terminal', 't']] (config)# crypto keyring <WORD> (config-keyring)# csr (config-csr)# email <WORD>
Description: enabling an SSL connection with the LDAP provider
Command Mode: ldap-server host : LDAP server DNS name or IP address
Command Path:
# configure [['terminal', 't']] (config)# ldap-server host <A.B.C.D|A:B::C:D|WORD> (config-host)# enable-ssl
Description: Enable AES Encryption
Command Mode: crypto aes : AES encryption configuration
Command Path:
# configure [['terminal', 't']] (config)# crypto aes (config-aes)# encryption
Description: Exit to the exec mode
Command Mode: exec : Exec Mode
Command Path:
# end
Description: Specify an endpoint retention policy for this VRF
Syntax:
retention |
Specify an endpoint retention policy for this VRF |
WORD |
Endpoint Retention Policy (Max Size 64) |
Command Mode: vrf : Configuration for vrf
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# vrf context <WORD> (config-tenant-vrf)# endpoint retention <WORD>
Description: Configure EP Loop Protection Action to BD-Learn-Disable
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# endpoint loop-detect action bd-learn-disable
Description: Configure EP Loop Protection Action to Port-Disable
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# endpoint loop-detect action port-disable
Description: Enable/Disable Endpoint Loop-Detect Policy
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# endpoint loop-detect enable
Description: Configure End Point Loop Detection Factor
Syntax:
<1-255> |
End Point Loop Protection Multipication Factor. Number range from=1 to=255 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# endpoint loop-detect factor <NUMBER>
Description: Configure End Point Loop Detection Interval
Syntax:
<30-300> |
End Point Loop Detection Interval. Number range from=30 to=300 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# endpoint loop-detect interval <NUMBER>
Description: Endpoint Move detection Mode
Syntax:
WORD |
Endpoint Move detection Mode |
Command Mode: bridge-domain : Configuration for bridge-domain
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# bridge-domain <WORD> (config-tenant-bd)# endpoint move-detection <WORD>
Description: Set the bounce age interval for endpoints
Syntax:
x in <0-0> or <150-65535> |
Set the Bounce Age Interval, use 0 for infinite |
Command Mode: bridge-domain : Configuration for bridge-domain
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# bridge-domain <WORD> (config-tenant-bd)# endpoint retention bounce-age-interval x in <0-0> or <150-65535>
Description: Set the bounce age interval for endpoints
Syntax:
x in <0-0> or <150-65535> |
Set the Bounce Age Interval, use 0 for infinite |
Command Mode: template endpoint retention policy : Configure an endpoint retention policy
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template endpoint retention policy <WORD> (config-tenant-template-endpoint-retention)# endpoint retention bounce-age-interval x in <0-0> or <150-65535>
Description: Set the hold interval for endpoints
Syntax:
<5-65535> |
Set the Hold Interval. Number range from=5 to=65535 |
Command Mode: bridge-domain : Configuration for bridge-domain
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# bridge-domain <WORD> (config-tenant-bd)# endpoint retention hold-interval <NUMBER>
Description: Set the hold interval for endpoints
Syntax:
<5-65535> |
Set the Hold Interval. Number range from=5 to=65535 |
Command Mode: template endpoint retention policy : Configure an endpoint retention policy
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template endpoint retention policy <WORD> (config-tenant-template-endpoint-retention)# endpoint retention hold-interval <NUMBER>
Description: Set the local endpoint age interval
Syntax:
x in <0-0> or <120-65535> |
Set the local endpoint age interval, use 0 for infinite |
Command Mode: bridge-domain : Configuration for bridge-domain
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# bridge-domain <WORD> (config-tenant-bd)# endpoint retention local-age-interval x in <0-0> or <120-65535>
Description: Set the local endpoint age interval
Syntax:
x in <0-0> or <120-65535> |
Set the local endpoint age interval, use 0 for infinite |
Command Mode: template endpoint retention policy : Configure an endpoint retention policy
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template endpoint retention policy <WORD> (config-tenant-template-endpoint-retention)# endpoint retention local-age-interval x in <0-0> or <120-65535>
Description: Set the move frequency
Syntax:
<0-65535> |
Set the move frequency. Number range from=0 to=65535 |
Command Mode: bridge-domain : Configuration for bridge-domain
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# bridge-domain <WORD> (config-tenant-bd)# endpoint retention move-frequency <NUMBER>
Description: Set the move frequency
Syntax:
<0-65535> |
Set the move frequency. Number range from=0 to=65535 |
Command Mode: template endpoint retention policy : Configure an endpoint retention policy
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template endpoint retention policy <WORD> (config-tenant-template-endpoint-retention)# endpoint retention move-frequency <NUMBER>
Description: Associate the BD with an endpoint retention policy
Syntax:
WORD |
Name of the endpoint retention policy to set (Max Size 64) |
Command Mode: bridge-domain : Configuration for bridge-domain
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# bridge-domain <WORD> (config-tenant-bd)# endpoint retention policy <WORD>
Description: Set the remote endpoint age interval
Syntax:
x in <0-0> or <120-65535> |
Remote endpoint age interval, use 0 for infinite |
Command Mode: bridge-domain : Configuration for bridge-domain
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# bridge-domain <WORD> (config-tenant-bd)# endpoint retention remote-age-interval x in <0-0> or <120-65535>
Description: Set the remote endpoint age interval
Syntax:
x in <0-0> or <120-65535> |
Remote endpoint age interval, use 0 for infinite |
Command Mode: template endpoint retention policy : Configure an endpoint retention policy
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template endpoint retention policy <WORD> (config-tenant-template-endpoint-retention)# endpoint retention remote-age-interval x in <0-0> or <120-65535>
Description: Subnet learning enforcement
Command Mode: bridge-domain : Configuration for bridge-domain
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# bridge-domain <WORD> (config-tenant-bd)# enforce-subnet-learning
Description: AEPg configuration mode
Syntax:
WORD |
Application EPG name (Max Size 64) |
WORD |
(Optional) Specify EPG type |
Command Mode: application : application configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# application <WORD> (config-tenant-app)# epg <WORD> [type <WORD>]
Description: Erase config and reboot
Command Mode: exec : Exec Mode
Command Path:
# eraseconfig
Description: Enable timer to recover from BPDU Guard error disable
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# errdisable recovery cause bpduguard
Description: Enable timer to recover from End Point Move error disable
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# errdisable recovery cause ep-move
Description: Enable timer to recover from MCP Loop error disable
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# errdisable recovery cause mcp-loop
Description: Configure Error Disable Recovery Interval
Syntax:
<30-65535> |
Timer-interval (sec). Number range from=30 to=65535 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# errdisable recovery interval <NUMBER>
Description: Erspan Id
Syntax:
id |
erspan Id. Number range from=1 to=1023 |
Command Mode: destination tenant : Configure monitor remote destination
Command Path:
# configure [['terminal', 't']] (config)# monitor access session <session_name> (config-monitor-access)# destination tenant <tenant_name> application <application_name> epg <epg_name> destination-ip <A.B.C.D> source-ip-prefix <A.B.C.D/M> (config-monitor-access-dest)# erspan-id <id>
Description: Erspan Id
Syntax:
id |
erspan Id. Number range from=1 to=1023 |
Command Mode: destination : Configure monitor remote destination
Command Path:
# configure [['terminal', 't']] (config)# monitor fabric session <session_name> (config-monitor-fabric)# destination tenant <tenant_name> application <application_name> epg <epg_name> destination-ip <A.B.C.D> source-ip-prefix <A.B.C.D/M> (config-monitor-fabric-dest)# erspan-id <id>
Description: Erspan Id
Syntax:
arg |
erspan Id. Number range from=1 to=1023 |
Command Mode: destination : Configure monitor remote destination
Command Path:
# configure [['terminal', 't']] (config)# monitor tenant <tenant_name> session <session_name> (config-monitor-tenant)# destination tenant <tenant_name> application <application_name> epg <epg_name> destination-ip <A.B.C.D> source-ip-prefix <A.B.C.D/M> (config-monitor-tenant-dest)# erspan-id <>
Description: Configure ERSPAN ID
Syntax:
arg |
ERSPAN ID. Number range from=1 to=1023 |
Command Mode: destination destip : Configure monitor remote destination
Command Path:
# configure [['terminal', 't']] (config)# monitor virtual session <WORD> (config-monitor-virtual)# destination destip <A.B.C.D> (config-monitor-virtual-remote-dest)# erspan-id <>
Description: Exec Mode
Command Mode: None
Description: Exit from current mode
Command Mode: exec : Exec Mode
Command Path:
# exit
Description: If expires enabled, Set expiration date of locally-authenticated user account.
Syntax:
DATE |
UTC Date format (YYYY-MM-DDTHH:MM:SS.mmm[+-]hh:mm) |
Command Mode: username : Create a locally-authenticated user account
Command Path:
# configure [['terminal', 't']] (config)# username <WORD> (config-username)# expiration <DATE>
Description: Enable expiry for locally-authenticated user account
Command Mode: username : Create a locally-authenticated user account
Command Path:
# configure [['terminal', 't']] (config)# username <WORD> (config-username)# expires
Description: Export a contract to another tenant
Syntax:
to |
Tenant to export the command to |
tenant |
Tenant to export the command to |
WORD |
Tenant to export the command to (Max Size 63) |
WORD |
(Optional) New name under which the contract will be known (Max Size 64) |
Command Mode: contract : Configure binary contracts between Application EPGs
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# contract <WORD> [type <type>] (config-tenant-contract)# export to tenant <WORD> [as <WORD>]
Description: VRF export
Syntax:
map |
Route-map for inter VRF route leak |
WORD |
Route Map Name (Max Size 63) |
Command Mode: vrf : Configure VRF parameters
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# vrf context tenant <WORD> vrf <WORD> [l3out <l3out>] (config-leaf-vrf)# export map <WORD>
Description: L2 external EPG creation/configuration
Syntax:
epg |
L2 external EPG name |
WORD |
L2 external EPG name (Max Size 64) |
Command Mode: tenant : tenant configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# external-l2 epg <WORD>
Description: External L3 EPG to associate
Syntax:
epg |
Specify the external EPG |
WORD |
External L3 EPG name |
Command Mode: vrf : Configure VRF parameters
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# vrf context tenant <WORD> vrf <WORD> [l3out <l3out>] (config-leaf-vrf)# external-l3 epg <WORD>
Description: External L3 EPG configuration mode
Syntax:
WORD |
External L3 EPG name (Max Size 49) |
oob-mgmt |
(Optional) External L3 EPG for Out of band |
l3out |
(Optional) Configure external-l3 epg on an API configured L3Out |
Command Mode: tenant : tenant configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# external-l3 epg <WORD> [oob-mgmt] [l3out <l3out>]