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: TACACS+ server's DNS name or its IP address
Syntax:
A.B.C.D|A:B::C:D|WORD |
TACACS+ server's DNS name or its IP address |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# tacacs-server host <A.B.C.D|A:B::C:D|WORD>
Description: Global TACACS+ server retries period in seconds
Syntax:
<0-5> |
Global TACACS+ server retries period in seconds. Number range from=0 to=5 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# tacacs-server retries <NUMBER>
Description: Global TACACS+ server timeout period in seconds
Syntax:
<1-60> |
Global TACACS+ server timeout period in seconds. Number range from=1 to=60 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# tacacs-server timeout <NUMBER>
Description: Add a tag to an epg
Syntax:
WORD |
Tag for the object (Max Size 64) |
Command Mode: epg : AEPg configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# application <WORD> (config-tenant-app)# epg <WORD> [type <WORD>] (config-tenant-app-epg)# tag <WORD>
Description: Add a tag to an application
Syntax:
WORD |
Tag for the object (Max Size 64) |
Command Mode: application : application configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# application <WORD> (config-tenant-app)# tag <WORD>
Description: Add a tag to the tenant
Syntax:
WORD |
Tag for the object (Max Size 64) |
Command Mode: tenant : tenant configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# tag <WORD>
Description: Set Route Tag
Syntax:
<0-4294967295> |
Route Tag Value. Number range from=0 to=4294967295 |
Command Mode: template route tag : Configure Route Tag Policy Templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template route tag <WORD> tenant <WORD> (config-route-tag)# tag <NUMBER>
Description: Configure target dn/class
Syntax:
self |
Self |
children |
Children |
subtree |
Subtree |
Command Mode: query : Configure Query profile Parameters
Command Path:
# configure [['terminal', 't']] (config)# callhome common (config-callhome)# query-profile (config-callhome-queryprof)# query <WORD> type dn|class <dn/classname> (config-callhome-queryprof-query)# target self|children|subtree
Description: Snapshot target
Syntax:
WORD |
infra, fabric or tenant-x |
Command Mode: snapshot export : Configuration export setup mode
Command Path:
# configure [['terminal', 't']] (config)# snapshot export <WORD> (config-export)# target <WORD>
Description: TELNET communication policy group
Command Mode: comm-policy : Configure any communication policy, ssh/telnet/shellinabox/http/https
Command Path:
# configure [['terminal', 't']] (config)# comm-policy <WORD> (config-comm-policy)# telnet
Description: BFD group of commands
Syntax:
ip |
IPV4 Address |
ipv6 |
IPV6 Address |
WORD |
Create a BFD policy |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# template bfd ip|ipv6 <WORD>
Description: Configure BFD Interface Policy Templates
Syntax:
WORD |
BFD Interface Policy name (Max Size 64) |
tenant |
Tenant for the BFD Policy |
WORD |
Tenant name (Max Size 63) |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template bfd <WORD> tenant <WORD>
Description: Configure Router BGP Address Family Templates
Syntax:
WORD |
BGP Address Family Policy Name (Max Size 64) |
tenant |
Tenant for the BGP Policy |
WORD |
Tenant Name |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template bgp address-family <WORD> tenant <WORD>
Description: Configure Router BGP Timer Policy Templates
Syntax:
WORD |
Router BGP Timer Policy Name (Max Size 64) |
tenant |
Tenant for the BGP Policy |
WORD |
Tenant Name (Max Size 63) |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template bgp timers <WORD> tenant <WORD>
Description: Configure expanded community list templates
Syntax:
WORD |
community name (Max Size 64) |
<regular expression> |
community regular expression |
tenant |
Tenant for the VRF |
WORD |
Tenant name |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template community-list expanded <WORD> <regular expression> tenant <WORD>
Description: Configure standard community list templates
Syntax:
WORD |
community name (Max Size 64) |
<community list> |
<community list> |
tenant |
Tenant for the VRF |
WORD |
Tenant name |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template community-list standard <WORD> <community list> tenant <WORD>
Description: Create a DHCP Option policy
Syntax:
policy |
Name of the DHCP Option Policy |
WORD |
Name of the DHCP Option Policy (Max Size 64) |
Command Mode: tenant : tenant configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template dhcp option policy <WORD>
Description: Create a DHCP Relay policy
Syntax:
policy |
Name of the DHCP relay policy |
WORD |
Name of the DHCP relay policy (Max Size 64) |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# template dhcp relay policy <WORD>
Description: Create a DHCP Relay policy
Syntax:
policy |
Name of the DHCP relay policy |
WORD |
Name of the DHCP relay policy (Max Size 64) |
Command Mode: tenant : tenant configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template dhcp relay policy <WORD>
Description: Configure EIGRP Interface policy templates
Syntax:
WORD |
Policy name (Max Size 64) |
tenant |
Tenant for the EIGRP Interface Policy |
WORD |
Tenant name |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template eigrp interface-policy <WORD> tenant <WORD>
Description: Configure EIGRP VRF policy templates
Syntax:
WORD |
Policy name (Max Size 64) |
tenant |
Tenant for the EIGRP VRF Policy |
WORD |
Tenant name |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template eigrp vrf-policy <WORD> tenant <WORD>
Description: Configure an endpoint retention policy
Syntax:
WORD |
Name of the endpoint retention policy to set (Max Size 64) |
Command Mode: tenant : tenant configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template endpoint retention policy <WORD>
Description: Configure expanded community list templates
Syntax:
WORD |
community name (Max Size 64) |
<regular expression> |
community regular expression |
tenant |
Tenant for the VRF |
WORD |
Tenant name |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template extcommunity-list expanded <WORD> <regular expression> tenant <WORD>
Description: Configure standard community list templates
Syntax:
WORD |
community name (Max Size 64) |
scope |
(Optional) transitive or non-transitive |
<community list> |
<community list> |
tenant |
Tenant for the VRF |
WORD |
Tenant name |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template extcommunity-list standard <WORD> [scope <scope>] <community list> tenant <WORD>
Description: Create an IGMP snooping policy
Syntax:
WORD |
Name of the IGMP snooping policy to define (Max Size 64) |
Command Mode: tenant : tenant configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template ip igmp snooping policy <WORD>
Description: Create/modify an an IPv6 Neighbor Discovery policy
Syntax:
WORD |
Name of the policy to create/modify (Max Size 64) |
Command Mode: tenant : tenant configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template ipv6 nd policy <WORD>
Description: Configure IPv6 Neighbor Discovery policy templates
Syntax:
WORD |
Policy name (Max Size 64) |
tenant |
Tenant for the ND Policy |
WORD |
Tenant name |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template ipv6 nd policy <WORD> tenant <WORD>
Description: Create/modify an an IPv6 Neighbor Prefix policy
Syntax:
policy |
IPv6 ND Prefix Policy |
WORD |
Name of the policy to create/modify (Max Size 64) |
Command Mode: tenant : tenant configuration mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD> (config-tenant)# template ipv6 nd prefix policy <WORD>
Description: Configure Leaf Policy Group
Syntax:
WORD |
Leaf Policy Group Name |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# template leaf-policy-group <WORD>
Description: Configure OSPF Interface Policy Templates
Syntax:
WORD |
OSPF Interface Policy name (Max Size 64) |
tenant |
Tenant for the OSPF Policy |
WORD |
Tenant name (Max Size 63) |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template ospf interface-policy <WORD> tenant <WORD>
Description: Configure Router OSPF Timer Policy Templates
Syntax:
WORD |
Router OSPF Timer Policy name (Max Size 64) |
tenant |
Tenant for the OSPF Policy |
WORD |
Tenant name (Max Size 63) |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template ospf vrf-policy <WORD> tenant <WORD>
Description: Configure Policy Group Parameters
Syntax:
WORD |
Interface Policy Group Name (Max Size 64) |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# template policy-group <WORD>
Description: Configure Port-Channel Parameters
Syntax:
WORD |
Port-Channel/VPC Name (Max Size 64) |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# template port-channel <WORD>
Description: Configure route-profile template under tenant for BGP dampening and route redistribution
Syntax:
WORD |
Route-profile template name (Max Size 64) |
tenant |
Tenant for the route-profile template |
WORD |
Tenant Name (Max Size 63) |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template route-profile <WORD> tenant <WORD>
Description: Configure route-profile template under VRF/L3Out for bridge-domain export
Syntax:
WORD |
Route-profile template 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)# template route-profile <WORD>
Description: Configure Route Tag Policy Templates
Syntax:
WORD |
Route Tag Policy Name (Max Size 64) |
tenant |
Tenant for the Route Tag Policy |
WORD |
Tenant Name (Max Size 63) |
Command Mode: leaf : Configure Leaf Node
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template route tag <WORD> tenant <WORD>
Description: tenant configuration mode
Syntax:
WORD |
tenant name (Max Size 63) |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# tenant <WORD>
Description: Enable or disable pager for command output
Syntax:
length |
Terminal length keyword |
NUMBER |
Terminal pager length (0=Disable pager). Number range from=0 to=511 |
Command Mode: exec : Exec Mode
Command Path:
# terminal length <NUMBER>
Description: Start controller-group upgrade
Syntax:
start |
Set time to trigger upgrade |
<date-time> |
Set the start time ([[[yyyy:]mmm:]dd:]HH:MM) |
Command Mode: controller-group : Controller Upgrade Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# firmware (config-firmware)# controller-group (config-firmware-controller)# time start <date-time>
Description: Set the window start time
Syntax:
start |
Set the start time |
TIME |
Set the start time [[[yyyy:]mmm:]dd:]HH:MM |
Command Mode: absolute : Absolute window configuration mode
Command Path:
# configure [['terminal', 't']] (config)# scheduler fabric|controller schedule <WORD> (config-scheduler)# absolute window <WORD> (config-scheduler-absolute)# time start <TIME>
Description: Specify a daily schedule
Syntax:
TIME |
Trigger time in HH:MM format |
Command Mode: recurring : Recurring window configuration mode
Command Path:
# configure [['terminal', 't']] (config)# scheduler fabric|controller schedule <WORD> (config-scheduler)# recurring window <WORD> (config-scheduler-recurring)# time start daily <TIME>
Description: Specify a weekly schedule
Syntax:
monday |
Mondays |
tuesday |
Tuesdays |
wednesday |
Wednesdays |
thursday |
Thursdays |
friday |
Fridays |
saturday |
Saturdays |
sunday |
Sundays |
even-day |
Even days |
odd-day |
Odd days |
every-day |
Everyday |
TIME |
Trigger time in HH:MM format |
Command Mode: recurring : Recurring window configuration mode
Command Path:
# configure [['terminal', 't']] (config)# scheduler fabric|controller schedule <WORD> (config-scheduler)# recurring window <WORD> (config-scheduler-recurring)# time start weekly monday|tuesday|wednesday|thursday|friday|saturday|sunday|even-day|odd-day|every-day <TIME>
Description: LDAP server timeout for authentication
Syntax:
<5-60> |
LDAP server timeout for authentication. Number range from=5 to=60 |
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)# timeout <NUMBER>
Description: RADIUS server timeout for authentication
Syntax:
<0-60> |
RADIUS server timeout for authentication |
Command Mode: radius-server host : RADIUS server's DNS name or its IP address
Command Path:
# configure [['terminal', 't']] (config)# radius-server host <A.B.C.D|A:B::C:D|WORD> (config-host)# timeout <0-60>
Description: TACACS server timeout for authentication
Syntax:
<0-60> |
TACACS server timeout for authentication. Number range from=0 to=60 |
Command Mode: tacacs-server host : TACACS+ server's DNS name or its IP address
Command Path:
# configure [['terminal', 't']] (config)# tacacs-server host <A.B.C.D|A:B::C:D|WORD> (config-host)# timeout <NUMBER>
Description: Set BGP Policy Timers
Syntax:
bgp |
Set BGP Policy Timers |
<0-3600> |
Keep-Alive Timer Value in Seconds. Number range from=0 to=3600 |
<0-3600> |
Hold Timer Value in Seconds. Number range from=0 to=3600 |
Command Mode: template bgp timers : Configure Router BGP Timer Policy Templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template bgp timers <WORD> tenant <WORD> (config-bgp-timers)# timers bgp <NUMBER> <NUMBER>
Description: Set EIGRP Timers
Syntax:
active-time |
Active timer interval |
<1-65535> |
Active timer interval value in minutes. Number range from=1 to=65535 |
Command Mode: template eigrp vrf-policy : Configure EIGRP VRF policy templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template eigrp vrf-policy <WORD> tenant <WORD> (config-template-eigrp-vrf-pol)# timers active-time <NUMBER>
Description: Set EIGRP Timers
Syntax:
active-time |
Active timer interval |
<1-65535> |
Active timer interval value in minutes. Number range from=1 to=65535 |
Command Mode: address-family : EIGRP Policy Address Family
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# router eigrp default (config-eigrp)# vrf member tenant <WORD> vrf <WORD> (config-eigrp-vrf)# address-family ipv4|ipv6 unicast (config-address-family)# timers active-time <NUMBER>
Description: Set the minimum interval between the arrival of each link-state advertisement(LSA)
Syntax:
<10-600000> |
Interval in milliseconds. Number range from=10 to=600000 |
Command Mode: template ospf vrf-policy : Configure Router OSPF Timer Policy Templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template ospf vrf-policy <WORD> tenant <WORD> (config-vrf-policy)# timers lsa-arrival <NUMBER>
Description: Set the interval in which LSAs are grouped and refreshed, checksummed, or aged
Syntax:
<1-1800> |
Interval in seconds. Number range from=1 to=1800 |
Command Mode: template ospf vrf-policy : Configure Router OSPF Timer Policy Templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template ospf vrf-policy <WORD> tenant <WORD> (config-vrf-policy)# timers lsa-group-pacing <NUMBER>
Description: Set the start-interval, hold-interval, max-interval for LSA
Syntax:
<start-time 0-5000> |
The generation throttle start-wait interval between LSAs.. Number range from=0 to=5000 |
<hold-interval 50-30000> |
The incremental time (in milliseconds) used to calculate the subsequent rate limiting times for LSA generation.. Number range from=50 to=30000 |
<max-time 50-30000> |
The generation throttle maximum interval between LSAs.. Number range from=50 to=30000 |
Command Mode: template ospf vrf-policy : Configure Router OSPF Timer Policy Templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template ospf vrf-policy <WORD> tenant <WORD> (config-vrf-policy)# timers throttle lsa <NUMBER> <NUMBER> <NUMBER>
Description: Set the SPF init-interval, hold-interval, max-interval for LSA
Syntax:
<spf-start 1-600000> |
The initial delay interval for the SPF schedule.. Number range from=1 to=600000 |
<spf-hold 1-600000> |
The minimum hold time between SPF calculations.. Number range from=1 to=600000 |
<spf-max-wait 1-600000> |
The maximum interval between SPF calculations. Each interval after the initial calculation is twice as long as the previous one until the wait interval reaches the maximum wait time specified.. Number range from=1 to=600000 |
Command Mode: template ospf vrf-policy : Configure Router OSPF Timer Policy Templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template ospf vrf-policy <WORD> tenant <WORD> (config-vrf-policy)# timers throttle spf <NUMBER> <NUMBER> <NUMBER>
Description: Set third-party certificate from trusted source/point for device identity
Syntax:
<WORD> |
third-party certificate (Max Size 16) |
Command Mode: crypto keyring : A keyring mode to create and hold an SSL certificate
Command Path:
# configure [['terminal', 't']] (config)# crypto keyring <WORD> (config-keyring)# tp <WORD>
Description: Set the delay time needed to send an LSA update packet.
Syntax:
<1-450> |
Delay in seconds. Number range from=1 to=450 |
Command Mode: template ospf interface-policy : Configure OSPF Interface Policy Templates
Command Path:
# configure [['terminal', 't']] (config)# leaf <101-4000> (config-leaf)# template ospf interface-policy <WORD> tenant <WORD> (config-interface-policy)# transmit-delay <NUMBER>
Description: The contact e-mail address
Syntax:
WORD |
The e-mail address (Max Size None) |
Command Mode: destination-profile : Configure destination profile Parameters
Command Path:
# configure [['terminal', 't']] (config)# callhome common (config-callhome)# destination-profile (config-callhome-destnprof)# transport email from <WORD>
Description: configure SMTP server
Syntax:
<host/ipaddr> |
The hostname or ipaddress of the destination |
port |
(Optional) Port Number. Number range from=1 to=633535 |
mgmtepg |
(Optional) mgmtepg |
Command Mode: destination-profile : Configure destination profile Parameters
Command Path:
# configure [['terminal', 't']] (config)# callhome common (config-callhome)# destination-profile (config-callhome-destnprof)# transport email mail-server <host/ipaddr> [port <port>] [mgmtepg <mgmtepg>]
Description: The contact e-mail address
Syntax:
WORD |
Reply-To e-mail address (Max Size None) |
Command Mode: destination-profile : Configure destination profile Parameters
Command Path:
# configure [['terminal', 't']] (config)# callhome common (config-callhome)# destination-profile (config-callhome-destnprof)# transport email reply-to <WORD>
Description: Trigger fabric recovery
Syntax:
<cluster-size> |
Size of the cluster. Number range from=1 to=16 |
WORD |
Snapshot import configuration name |
Command Mode: exec : Exec Mode
Command Path:
# trigger fabric-recovery <NUMBER> <WORD>
Description: Shutdown controller
Syntax:
controller |
Shutdown controller |
<1-32> |
Controller id. Number range from=1 to=32 |
Command Mode: exec : Exec Mode
Command Path:
# trigger shutdown controller <NUMBER>
Description: Trigger command for snapshot download
Syntax:
WORD |
Snapshot download configuration name |
Command Mode: exec : Exec Mode
Command Path:
# trigger snapshot download <WORD>
Description: Trigger command for snapshot export
Syntax:
WORD |
Snapshot export configuration name |
Command Mode: exec : Exec Mode
Command Path:
# trigger snapshot export <WORD>
Description: Trigger command for snapshot import
Syntax:
WORD |
Snapshot import configuration name |
Command Mode: exec : Exec Mode
Command Path:
# trigger snapshot import <WORD>
Description: Trigger command for snapshot rollback
Syntax:
WORD |
Snapshot rollback configuration name |
Command Mode: exec : Exec Mode
Command Path:
# trigger snapshot rollback <WORD>
Description: Trigger command for snapshot upload
Syntax:
WORD |
Snapshot upload configuration name |
Command Mode: exec : Exec Mode
Command Path:
# trigger snapshot upload <WORD>
Description: Trigger techsupport for controllers and switches
Syntax:
remote-path |
(Optional) remote-path |
Command Mode: exec : Exec Mode
Command Path:
# trigger techsupport all [remotename <remote-path>]
Description: Trigger techsupport for a controllers
Syntax:
remote-path |
(Optional) remote-path |
Command Mode: exec : Exec Mode
Command Path:
# trigger techsupport controllers [remotename <remote-path>]
Description: Trigger techsupport for a host
Syntax:
<Odevid> |
Specify the host Odev ID. Number range from=0 to=9223372036854775807 |
remotename |
Specify the file remote path name |
<remote-file-name> |
Remote path file name |
<leaf-node-id> |
(Optional) Specify the leaf node id |
Command Mode: exec : Exec Mode
Command Path:
# trigger techsupport host <NUMBER> remotename <remote-file-name> [node <leaf-node-id>]
Description: Trigger techsupport for a local
Command Mode: exec : Exec Mode
Command Path:
# trigger techsupport local
Description: Trigger techsupport for a switch
Syntax:
switchId <switchId> |
switch id 101-4000 or range(s): 101-103,104 |
remote-path |
(Optional) remote-path |
Command Mode: exec : Exec Mode
Command Path:
# trigger techsupport switch switchId <switchId> [remotename <remote-path>]
Description: Trigger a report generation for a troubleshoot session
Syntax:
session |
session |
session_name |
Session name |
format |
(Optional) Report format |
Command Mode: exec : Exec Mode
Command Path:
# trigger troubleshoot epext session <session_name> report [format <format>]
Description: Trigger a report generation for a troubleshoot session
Syntax:
session |
session |
session_name |
Session name |
format |
(Optional) Report format |
Command Mode: exec : Exec Mode
Command Path:
# trigger troubleshoot eptoep session <session_name> report [format <format>]
Description: Trigger VMware vCenter inventory pull
Syntax:
domain |
VMware domain |
<name> |
VMM VMware Domain name |
vcenter |
VMware vCenter |
<hostname|IP> |
vCenter hostname or IP |
pull-inventory |
Pull inventory |
Command Mode: exec : Exec Mode
Command Path:
# trigger vmware domain <name> vcenter <hostname|IP> pull-inventory
Description: Start atomic counter of a troubleshoot session
Syntax:
session |
session |
session_name |
session name |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> atomiccounter
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Set the description of a troubleshoot session
Syntax:
session |
session |
session_name |
session name |
LINE |
Session description, use single quotes with spaces ex: 'my descr' (Max Size 128) |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> description <LINE>
Description: Set the time window in number of minutes from current time
Syntax:
session |
session |
session_name |
session name |
minutes |
number of minutes from current time. Number range from=5 to=1440 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> latestminutes <minutes>
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Configure this APIC as monitor destination
Syntax:
session |
session |
session_name |
session name |
destination |
destinaton |
srcipprefix |
srcipprefix |
sip/m |
Source IP adddress and subnet mask length |
aip |
(Optional) IP address of the host analyser |
id |
(Optional) erspan Id. Number range from=1 to=1023 |
pathep-list |
(Optional) List of source fabricPathEp dn |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> monitor destination apic srcipprefix <sip/m> [analyser <aip>] [erspan-id <id>] [spansrcports <pathep-list>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Configure a predefined monitor destination
Syntax:
session |
session |
session_name |
session name |
destination |
destinaton |
destgroup_name |
Destination group name |
pathep-list |
(Optional) List of source fabricPathEp dn |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> monitor destination prefdestgroup <destgroup_name> [spansrcports <pathep-list>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Configure tenant EPG as monitor destination
Syntax:
session |
session |
session_name |
session name |
destination |
destinaton |
tn_name |
tenant name |
application |
application |
ap_name |
application name |
epg |
epg |
epg_name |
epg name |
destip |
destip |
dip |
destination IP address |
srcipprefix |
srcipprefix |
sip/m |
source IP address and subnet mask length |
id |
(Optional) erspan Id. Number range from=1 to=1023 |
pathep-list |
(Optional) List of source fabricPathEp dn |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> monitor destination tenant <tn_name> application <ap_name> epg <epg_name> destip <dip> srcipprefix <sip/m> [erspan-id <id>] [spansrcports <pathep-list>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Associate a scheduler to the troubleshoot session
Syntax:
session |
session |
session_name |
session name |
sch_name |
scheduler name |
format |
(Optional) Reoport format |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> scheduler <sch_name> [format <format>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: application
Syntax:
session |
session |
session_name |
session name |
sip |
external source IP |
destip |
destip |
dip |
destination IP |
tenant |
tenant |
dtenant_name |
destination Tenant |
dapp_name |
destination Application |
epg |
epg |
depg_name |
destination EPG |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> srcextip <sip> destip <dip> tenant <dtenant_name> application <dapp_name> epg <depg_name>
Description: vrf
Syntax:
session |
session |
session_name |
session name |
sip |
external source IP |
destip |
destip |
dip |
destination IP |
tenant |
tenant |
dtenant_name |
destination Tenant |
dvrf_name |
destination VRF |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> srcextip <sip> destip <dip> tenant <dtenant_name> vrf <dvrf_name>
Description: External IP
Syntax:
session |
session |
session_name |
session name |
sip |
source IP |
tenant |
tenant |
stenant_name |
source Tenant |
sapp_name |
source Application |
epg |
epg |
sepg_name |
source EPG |
dip |
external destination IP |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> srcip <sip> tenant <stenant_name> application <sapp_name> epg <sepg_name> destextip <dip>
Description: external IP
Syntax:
session |
session |
session_name |
session name |
sip |
source IP |
tenant |
tenant |
stenant_name |
source Tenant |
svrf_name |
source VRF |
dip |
external destination IP |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> srcip <sip> tenant <stenant_name> vrf <svrf_name> destextip <dip>
Description: Configure the start/end time of the session
Syntax:
session |
session |
session_name |
session name |
start_time |
Start time (in YYYY-MM-DDTHH:MM:SS format) |
endtime |
end time |
end_time |
End time (in YYYY-MM-DDTHH:MM:SS format) |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> starttime <start_time> endtime <end_time>
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Start traceroute of a troubleshoot session
Syntax:
session |
session |
session_name |
session name |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> traceroute
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: ICMP protocol
Syntax:
session |
session |
session_name |
session name |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> traceroute protocol icmp
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: TCP protocol
Syntax:
session |
session |
session_name |
session name |
port |
(Optional) TCP destination port number. Number range from=0 to=65535 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> traceroute protocol tcp [destport <port>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: UDP protocol
Syntax:
session |
session |
session_name |
session name |
port |
(Optional) UDP destination port number. Number range from=0 to=65535 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot epext session <session_name> traceroute protocol udp [destport <port>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Start atomic counter of a troubleshoot session
Syntax:
session |
session |
session_name |
session name |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> atomiccounter
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Set the description of a troubleshoot session
Syntax:
session |
session |
session_name |
session name |
LINE |
Session description, use single quotes with spaces ex: 'my descr' (Max Size 128) |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> description <LINE>
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Set the time window in number of minutes from current time
Syntax:
session |
session |
session_name |
session name |
minutes |
number of minutes from current time. Number range from=5 to=1440 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> latestminutes <minutes>
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Configure this APIC as monitor destination
Syntax:
session |
session |
session_name |
session name |
destination |
destinaton |
srcipprefix |
srcipprefix |
sip/m |
Source IP adddress and subnet mask length |
aip |
(Optional) IP address of the host analyser |
id |
(Optional) erspan Id. Number range from=1 to=1023 |
pathep-list |
(Optional) List of source fabricPathEp dn |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> monitor destination apic srcipprefix <sip/m> [analyser <aip>] [erspan-id <id>] [spansrcports <pathep-list>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Configure a predefined monitor destination
Syntax:
session |
session |
session_name |
session name |
destination |
destinaton |
destgroup_name |
Destination group name |
pathep-list |
(Optional) List of source fabricPathEp dn |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> monitor destination prefdestgroup <destgroup_name> [spansrcports <pathep-list>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Configure tenant EPG as monitor destination
Syntax:
session |
session |
session_name |
session name |
destination |
destinaton |
tn_name |
tenant name |
application |
application |
ap_name |
application name |
epg |
epg |
epg_name |
epg name |
destip |
destip |
dip |
destination IP address |
srcipprefix |
srcipprefix |
sip/m |
source IP address and subnet mask lenght |
id |
(Optional) erspan Id. Number range from=1 to=1023 |
pathep-list |
(Optional) List of source fabricPathEp dn |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> monitor destination tenant <tn_name> application <ap_name> epg <epg_name> destip <dip> srcipprefix <sip/m> [erspan-id <id>] [spansrcports <pathep-list>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Associate a scheduler to the troubleshoot session
Syntax:
session |
session |
session_name |
session name |
sch_name |
scheduler name |
format |
(Optional) Report format |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> scheduler <sch_name> [format <format>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: application
Syntax:
session |
session |
session_name |
session name |
sip |
source IP |
tenant |
tenant |
stenant_name |
source Tenant |
sapp_name |
source Application |
epg |
epg |
sepg_name |
source EPG |
destip |
destip |
dip |
destination IP |
tenant |
tenant |
dtenant_name |
destination Tenant |
dapp_name |
destination Application |
epg |
epg |
depg_name |
destination EPG |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> srcip <sip> tenant <stenant_name> application <sapp_name> epg <sepg_name> destip <dip> tenant <dtenant_name> application <dapp_name> epg <depg_name>
Description: vrf
Syntax:
session |
session |
session_name |
session name |
sip |
source IP |
tenant |
tenant |
stenant_name |
source Tenant |
sapp_name |
source Application |
epg |
epg |
sepg_name |
source EPG |
destip |
destip |
dip |
destination IP |
tenant |
tenant |
dtenant_name |
destination Tenant |
dvrf_name |
destination VRF |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> srcip <sip> tenant <stenant_name> application <sapp_name> epg <sepg_name> destip <dip> tenant <dtenant_name> vrf <dvrf_name>
Description: application
Syntax:
session |
session |
session_name |
session name |
sip |
source IP |
tenant |
tenant |
stenant_name |
source Tenant |
svrf_name |
source VRF |
destip |
destip |
dip |
destination IP |
tenant |
tenant |
dtenant_name |
destination Tenant |
dapp_name |
destination Application |
epg |
epg |
depg_name |
destination EPG |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> srcip <sip> tenant <stenant_name> vrf <svrf_name> destip <dip> tenant <dtenant_name> application <dapp_name> epg <depg_name>
Description: vrf
Syntax:
session |
session |
session_name |
session name |
sip |
source IP |
tenant |
tenant |
stenant_name |
source Tenant |
svrf_name |
source VRF |
destip |
destip |
dip |
destination IP |
tenant |
tenant |
dtenant_name |
destination Tenant |
WORD |
destination VRF |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> srcip <sip> tenant <stenant_name> vrf <svrf_name> destip <dip> tenant <dtenant_name> vrf <WORD>
Description: application
Syntax:
session |
session |
session_name |
session name |
smac |
source MAC |
tenant |
tenant |
stenant_name |
source Tenant |
sapp_name |
source Application |
epg |
epg |
sepg_name |
source EPG |
destmac |
destmac |
dmac |
destination MAC |
tenant |
tenant |
dtenant_name |
destination Tenant |
dapp_name |
destination Application |
epg |
epg |
depg_name |
destination EPG |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> srcmac <smac> tenant <stenant_name> application <sapp_name> epg <sepg_name> destmac <dmac> tenant <dtenant_name> application <dapp_name> epg <depg_name>
Description: vrf
Syntax:
session |
session |
session_name |
session name |
smac |
source MAC |
tenant |
tenant |
stenant_name |
source Tenant |
sapp_name |
source Application |
epg |
epg |
sepg_name |
source EPG |
destmac |
destmac |
dmac |
destination MAC |
tenant |
tenant |
dtenant_name |
destination Tenant |
dvrf_name |
destination VRF |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> srcmac <smac> tenant <stenant_name> application <sapp_name> epg <sepg_name> destmac <dmac> tenant <dtenant_name> vrf <dvrf_name>
Description: application
Syntax:
session |
session |
session_name |
session name |
smac |
source MAC |
tenant |
tenant |
stenant_name |
source Tenant |
svrf_name |
source VRF |
destmac |
destmac |
dmac |
destination MAC |
tenant |
tenant |
dtenant_name |
destination Tenant |
dapp_name |
destination Application |
epg |
epg |
depg_name |
destination EPG |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> srcmac <smac> tenant <stenant_name> vrf <svrf_name> destmac <dmac> tenant <dtenant_name> application <dapp_name> epg <depg_name>
Description: vrf
Syntax:
session |
session |
session_name |
session name |
smac |
source MAC |
tenant |
tenant |
stenant_name |
source Tenant |
svrf_name |
source VRF |
destmac |
destmac |
dmac |
destination MAC |
tenant |
tenant |
dtenant_name |
destination Tenant |
dvrf_name |
destination VRF |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> srcmac <smac> tenant <stenant_name> vrf <svrf_name> destmac <dmac> tenant <dtenant_name> vrf <dvrf_name>
Description: Configure the start/end time of the session
Syntax:
session |
session |
session_name |
session name |
start_time |
Start time (in YYYY-MM-DDTHH:MM:SS format) |
endtime |
end time |
end_time |
End time (in YYYY-MM-DDTHH:MM:SS format) |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> starttime <start_time> endtime <end_time>
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Start traceroute of a troubleshoot session
Syntax:
session |
session |
session_name |
session name |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> traceroute
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: ICMP protocol
Syntax:
session |
session |
session_name |
session name |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> traceroute protocol icmp
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: TCP protocol
Syntax:
session |
session |
session_name |
session name |
port |
(Optional) TCP destination port number. Number range from=0 to=65535 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> traceroute protocol tcp [destport <port>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: UDP protocol
Syntax:
session |
session |
session_name |
session name |
port |
(Optional) UDP destination port number. Number range from=0 to=65535 |
Command Mode: configure : Configuration Mode
Command Path:
# configure [['terminal', 't']] (config)# troubleshoot eptoep session <session_name> traceroute protocol udp [destport <port>]
Usage Note:
The usage of the troubleshoot epext session commands and the troubleshoot eptoep session commands differs in the following way:
Use the troubleshoot epext session command when one endpoint is local to the fabric and the other endpoint is external to the fabric.
Use the troubleshoot eptoep session command when both endpoints are local to the fabric.
Description: Configure trusted for ntp authentication key
Syntax:
id |
Id for the trusted key. Number range from=1 to=65535 |
Command Mode: ntp : Configure the default ntp policy
Command Path:
# configure [['terminal', 't']] (config)# pod 1 (config-pod)# ntp (config-ntp)# trusted-key <id>