Table Of ContentCisco Application Policy Infrastructure Controller Enterprise Module
Configuration Guide, Release 1.2.x
First Published: November02,2015
Last Modified: May26,2016
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THESPECIFICATIONSANDINFORMATIONREGARDINGTHEPRODUCTSINTHISMANUALARESUBJECTTOCHANGEWITHOUTNOTICE.ALLSTATEMENTS,
INFORMATION,ANDRECOMMENDATIONSINTHISMANUALAREBELIEVEDTOBEACCURATEBUTAREPRESENTEDWITHOUTWARRANTYOFANYKIND,
EXPRESSORIMPLIED.USERSMUSTTAKEFULLRESPONSIBILITYFORTHEIRAPPLICATIONOFANYPRODUCTS.
THESOFTWARELICENSEANDLIMITEDWARRANTYFORTHEACCOMPANYINGPRODUCTARESETFORTHINTHEINFORMATIONPACKETTHATSHIPPEDWITH
THEPRODUCTANDAREINCORPORATEDHEREINBYTHISREFERENCE.IFYOUAREUNABLETOLOCATETHESOFTWARELICENSEORLIMITEDWARRANTY,
CONTACTYOURCISCOREPRESENTATIVEFORACOPY.
TheCiscoimplementationofTCPheadercompressionisanadaptationofaprogramdevelopedbytheUniversityofCalifornia,Berkeley(UCB)aspartofUCB'spublicdomainversion
oftheUNIXoperatingsystem.Allrightsreserved.Copyright©1981,RegentsoftheUniversityofCalifornia.
NOTWITHSTANDINGANYOTHERWARRANTYHEREIN,ALLDOCUMENTFILESANDSOFTWAREOFTHESESUPPLIERSAREPROVIDED“ASIS"WITHALLFAULTS.
CISCOANDTHEABOVE-NAMEDSUPPLIERSDISCLAIMALLWARRANTIES,EXPRESSEDORIMPLIED,INCLUDING,WITHOUTLIMITATION,THOSEOF
MERCHANTABILITY,FITNESSFORAPARTICULARPURPOSEANDNONINFRINGEMENTORARISINGFROMACOURSEOFDEALING,USAGE,ORTRADEPRACTICE.
INNOEVENTSHALLCISCOORITSSUPPLIERSBELIABLEFORANYINDIRECT,SPECIAL,CONSEQUENTIAL,ORINCIDENTALDAMAGES,INCLUDING,WITHOUT
LIMITATION,LOSTPROFITSORLOSSORDAMAGETODATAARISINGOUTOFTHEUSEORINABILITYTOUSETHISMANUAL,EVENIFCISCOORITSSUPPLIERS
HAVEBEENADVISEDOFTHEPOSSIBILITYOFSUCHDAMAGES.
AnyInternetProtocol(IP)addressesandphonenumbersusedinthisdocumentarenotintendedtobeactualaddressesandphonenumbers.Anyexamples,commanddisplayoutput,network
topologydiagrams,andotherfiguresincludedinthedocumentareshownforillustrativepurposesonly.AnyuseofactualIPaddressesorphonenumbersinillustrativecontentisunintentional
andcoincidental.
CiscoandtheCiscologoaretrademarksorregisteredtrademarksofCiscoand/oritsaffiliatesintheU.S.andothercountries.ToviewalistofCiscotrademarks,gotothisURL:http://
www.cisco.com/go/trademarks.Third-partytrademarksmentionedarethepropertyoftheirrespectiveowners.Theuseofthewordpartnerdoesnotimplyapartnership
relationshipbetweenCiscoandanyothercompany.(1110R)
©2015-2016CiscoSystems,Inc.Allrightsreserved.
CONTENTS
Preface Preface ix
Audience ix
DocumentConventions ix
RelatedDocumentation xi
ObtainingDocumentationandSubmittingaServiceRequest xii
CHAPTER 1 NewandChangedInformation 1
NewandChangedInformation 1
CHAPTER 2 Overview 3
AbouttheCiscoApplicationPolicyInfrastructureControllerEnterpriseModule 3
LoggingintotheCiscoAPIC-EM 5
HomeTab 6
SystemHealthTab 6
CiscoAPIC-EMGUI 9
ManagementApplications 13
CiscoNetworkPlugandPlay 13
CiscoIntelligentWAN(IWAN) 14
CHAPTER 3 ManagingUsersandRoles 15
AboutUserProfiles 15
AboutUserRoles 16
AdministratorRole 16
PolicyAdministratorRole 17
ObserverRole 17
InstallerRole 17
UsersandDomains 18
Cisco Application Policy Infrastructure Controller Enterprise Module Configuration Guide, Release 1.2.x
iii
Contents
AboutAAA 18
AuthenticationandAuthorization 18
CiscoAPIC-EMResourcesandPermissions 19
Accounting 21
ChangingYourPassword 21
ConfiguringUsersandRoles 23
AddingaUser 24
DeletingaUser 25
ViewingandEditingUserInformation 26
ViewingUserAccessStatus 26
ConfiguringExternalAuthentication 28
CHAPTER 4 DiscoveringDevicesandHosts 33
AboutDiscovery 33
UnderstandingDeviceandHostDiscovery 34
DiscoveryCredentialsRules 34
DiscoveryCredentialsCaveats 35
PerformingDiscovery 36
PerformingDiscoveryUsingCDP 37
PerformingDiscoveryUsinganIPAddressRange 41
CopyingaDiscoveryJob 45
StoppingandStartingaDiscoveryJob 45
DeletingaDiscoveryJob 46
UnderstandingtheDiscoveryResults 46
CHAPTER 5 ManagingDevicesandHosts 49
ManagingYourDeviceInventory 50
FilteringDevicesintheDeviceInventoryWindow 57
ChangingtheDevicesLayoutView 58
ChangingtheDeviceRole 60
DeletingaDevice 61
AddingorRemovingaDeviceTaginDeviceInventory 62
AddingorRemovingaPolicyTaginDeviceInventory 63
AddingorRemovingaLocationTag 64
AddingorRemovingaLocationMarker 66
Cisco Application Policy Infrastructure Controller Enterprise Module Configuration Guide, Release 1.2.x
iv
Contents
DeletingaTag 68
ManagingYourHostInventory 69
ChangingtheHostsTableView 71
CHAPTER 6 UsingtheTopologyMap 73
AboutTopology 73
TopologyToolbar 75
TopologyIcons 78
DisplayingDeviceData 80
AggregatingDevices 81
AggregatingDevicesintheTopologyWindow 81
DisaggregatingDevicesintheTopologyWindow 82
ChangingtheAggregatedDevicesLabel 84
ConfiguringtheTopologyStructure 85
SavingaTopologyLayout 87
OpeningaSavedTopologyLayout 88
ChangingaDevice'sRoleFromtheTopologyWindow 89
SearchingforDevices 91
AddingorRemovingaDeviceTaginTopology 93
AddingorRemovingaPolicyTaginTopology 94
DisplayingDeviceswithTags 95
CHAPTER 7 ConfiguringQualityofService 97
AboutEasyQoS 97
EasyQoSPrerequisites 98
UnderstandingQoSPolicies 98
PolicyScope 99
StaticandDynamicQoSPolicies 99
PolicyVersioning 100
ProcessingOrderforDeviceswithLimitedResources 100
UnderstandingApplications 102
Business-RelevanceGroups 102
Marking,Queuing,andDroppingTreatments 102
CustomApplications 105
FavoriteApplications 106
Cisco Application Policy Infrastructure Controller Enterprise Module Configuration Guide, Release 1.2.x
v
Contents
UnderstandingDynamicQoS 106
EasyQoSGuidelinesandLimitations 106
EnablingtheEasyQoSBetaFeature 107
GettingStartedwithEasyQoS 108
ConfiguringQoSPolicies 111
DefiningaPolicyScope 114
CreatingaPolicy 115
EditingaPolicy 116
RollingBackaPolicytoaPreviousVersion 117
CloningaPolicy 118
DeletingaPolicy 119
ConfiguringFavoriteApplications 120
EnablingandDisablingDynamicQoSPolicies 121
CreatingaCustomApplication 122
EditingaCustomApplication 123
DeletingaCustomApplication 124
CHAPTER 8 PerformingPathTraces 127
AboutPathTrace 127
SupportedNetworkEnvironments 129
SupportedProtocols,NetworkConnections,andFeatures 129
PerformingaPathTrace 133
PerforminganACL-BasedPathTrace 135
CollectingStatisticsDuringaPathTrace 137
UnderstandingPathTraceResults 140
UnderstandingtheStatisticsRetrievedDuringaPathTrace 144
DeviceStatistics 144
InterfaceStatistics 145
QoSStatistics 147
PerformanceMonitorStatistics 149
UnderstandingVRFPathTraceResults 150
UnderstandingACLPathTraceResults 150
CHAPTER 9 ReviewingtheAPIDocumentation 153
AbouttheCiscoAPIC-EMAPIDocumentation 153
Cisco Application Policy Infrastructure Controller Enterprise Module Configuration Guide, Release 1.2.x
vi
Contents
SupportedHTTPSMethodsandGeneralStructure 156
CommonExternalRESTfulServicesHTTPResponseCodes 156
UsingtheCiscoAPIC-EMRESTAPIWindow 157
APPENDIX A RequiredDeviceConfiguration 161
RequiredPlatformConfigurations 161
NETCONFConfiguration 162
CiscoNetFlowConfiguration 163
SNMPTrapConfiguration 163
IPDeviceTrackingConfiguration 163
WirelessLANControllerConfiguration 164
WANInterfaceConfigurationforEasyQoS 164
PerformanceMonitorConfiguration 167
Cisco Application Policy Infrastructure Controller Enterprise Module Configuration Guide, Release 1.2.x
vii
Contents
Cisco Application Policy Infrastructure Controller Enterprise Module Configuration Guide, Release 1.2.x
viii
Preface
• Audience, page ix
• DocumentConventions, page ix
• RelatedDocumentation, page xi
• ObtainingDocumentationandSubmittingaServiceRequest, page xii
Audience
ThispublicationisforexperiencednetworkadministratorswhowillconfigureandmaintaintheCisco
ApplicationPolicyInfrastructureControllerEnterpriseModule(CiscoAPIC-EM).
SeethefollowingguidesforadditionalinformationabouttheCiscoAPIC-EM:
•ForinformationabouttheCiscoAPIC-EMitself,includinginformationregardinginstallation,deployment,
verification,andtroubleshooting,seethe CiscoApplicationPolicyInfrastructureControllerEnterprise
ModuleDeploymentGuide.
•Forinformationaboutusingthecontroller'sGUIforthefirsttime,seetheCiscoAPIC-EMQuickStart
Guide.
Note TheCiscoApplicationPolicyInfrastructureControllerEnterpriseModule(CiscoAPIC-EM)isalso
referredtowithinthisconfigurationguideasacontroller.
Document Conventions
Thisdocumentusesthefollowingconventions:
Cisco Application Policy Infrastructure Controller Enterprise Module Configuration Guide, Release 1.2.x
ix
Preface
Document Conventions
Convention Description
^orCtrl Boththe^symbolandCtrlrepresenttheControl(Ctrl)keyonakeyboard.For
example,thekeycombination^DorCtrl-DmeansthatyouholddowntheControl
keywhileyoupresstheDkey.(Keysareindicatedincapitallettersbutarenot
casesensitive.)
boldfont Commandsandkeywordsanduser-enteredtextappearinboldfont.
Italic font Documenttitles,neworemphasizedterms,andargumentsforwhichyousupply
valuesareinitalicfont.
Courierfont Terminalsessionsandinformationthesystemdisplaysappearincourierfont.
Bold Courierfont Bold Courierfontindicatestextthattheusermustenter.
[x] Elementsinsquarebracketsareoptional.
... Anellipsis(threeconsecutivenonboldedperiodswithoutspaces)afterasyntax
elementindicatesthattheelementcanberepeated.
| Averticalline,calledapipe,indicatesachoicewithinasetofkeywordsor
arguments.
[x|y] Optionalalternativekeywordsaregroupedinbracketsandseparatedbyvertical
bars.
{x|y} Requiredalternativekeywordsaregroupedinbracesandseparatedbyvertical
bars.
[x{y|z}] Nestedsetofsquarebracketsorbracesindicateoptionalorrequiredchoices
withinoptionalorrequiredelements.Bracesandaverticalbarwithinsquare
bracketsindicatearequiredchoicewithinanoptionalelement.
string Anonquotedsetofcharacters.Donotusequotationmarksaroundthestringor
thestringwillincludethequotationmarks.
<> Nonprintingcharacterssuchaspasswordsareinanglebrackets.
[] Defaultresponsestosystempromptsareinsquarebrackets.
!,# Anexclamationpoint(!)orapoundsign(#)atthebeginningofalineofcode
indicatesacommentline.
Reader Alert Conventions
Thisdocumentmayusethefollowingconventionsforreaderalerts:
Cisco Application Policy Infrastructure Controller Enterprise Module Configuration Guide, Release 1.2.x
x
Description:relationship between Cisco and any other company. (1110R). © 2015-2016 Cisco Systems, Inc. About the Cisco APIC-EM API Documentation 153 Using the Cisco APIC-EM REST API Window 157 .. Critical (red octagon icon).
