Cisco APIC Object Model Command-Line Interface User Guide

64 Pages·2016·2.41 MB·English

Cisco APIC Object Model Command-Line Interface User Guide
Last Modified: December08,2015
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: [phone]
800 553-NETS (6387)
Fax: [phone]
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.
ThisproductincludescryptographicsoftwarewrittenbyEricYoung([e-mail]).
ThisproductincludessoftwaredevelopedbytheOpenSSLProjectforuseintheOpenSSLToolkit.(http://www.openssl.org/)
ThisproductincludessoftwarewrittenbyTimHudson([e-mail]).
CiscoandtheCiscologoaretrademarksorregisteredtrademarksofCiscoand/oritsaffiliatesintheU.S.andothercountries.ToviewalistofCiscotrademarks,gotothisURL:http://
www.cisco.com/go/trademarks.Third-partytrademarksmentionedarethepropertyoftheirrespectiveowners.Theuseofthewordpartnerdoesnotimplyapartnership
relationshipbetweenCiscoandanyothercompany.(1110R)
PleasesendgeneralFSF&[e-mail]othercorrectionsorsuggestionsto
[e-mail] TranslationsREADMEforinformationoncoordinatingandsubmittingtranslationsofthisarticle.
Copyright©2007,2009,2011FreeSoftwareFoundation,Inc.Verbatimcopyinganddistributionofthisentirearticlearepermittedworldwide,withoutroyalty,inanymedium,provided
thisnotice,andthecopyrightnotice,arepreserved.Updated:Date:2011/06/2802:44:32
©2014-2015CiscoSystems,Inc.Allrightsreserved.
CONTENTS
Preface Preface vii
Audience vii
DocumentConventions vii
RelatedDocumentation ix
DocumentationFeedback ix
CHAPTER 1 UnderstandingtheCommand-LineInterface 1
AbouttheApplicationPolicyInfrastructureController 1
ConfigurationOptions 1
UnderstandingManagedObjects 2
UnderstandingtheFileSystem 2
UnderstandingtheGNUBashShell 3
BashExtensions 3
NetworkingNamingConventions 3
InterfaceNaming 3
NetworkAddressNaming 4
CommandCompletion 4
CommandHistory 4
CommandHelp 4
MountPoints 5
aciMountPoint 5
mitMountPoint 5
debugMountPoint 5
Role-BasedAccessControl 6
ApplyingPermissionsandSecurity 6
UserManagement 6
Cisco APIC Object Model Command-Line Interface User Guide
iii
Contents
CHAPTER 2 UsingtheAPICCLI 7
AccessingtheObjectModelCLI 7
ViewingManagedObjects 8
NavigatingtheManagementInformationTree 8
MOBrowserUtility 9
EnteringaConfiguration 9
DisplayingCommandDifferences 10
UsingConfigurationWizards 10
SkippingProperties 11
CreatingConfigurationTemplates 12
CreatingTemplatesUsingthemoconfigCommand 12
CreatingTemplatesusingConfigurationWizards 13
CustomizingCommands 13
SampleYAMLCommandDefinitions 14
YAMLFileFormat 16
CHAPTER 3 CommandReference 19
CommandHelp 20
attach 20
auditlog 21
create 21
controller 22
diagnostics 23
eraseconfig 24
eventlog 24
faults 25
firmware 26
health 28
loglevel 29
man 30
mobrowser 30
moconfig 31
mocreate 32
modelete 32
Cisco APIC Object Model Command-Line Interface User Guide
iv
Contents
mofind 33
moprint 33
moquery 35
moset 36
mostats 37
password 39
reload 40
scope 40
show 41
svcping 42
techsupport 43
trafficmap 44
troubleshooteptoepsession(IPandMAC) 45
troubleshootepextsessionEP-to-External-IPandExternal-IP-to-EP 46
troubleshooteptoepsession<sessionname> 46
troubleshooteptoepsession<sessionname>atomiccounter 47
troubleshooteptoepsession<sessionname>traceroute 48
troubleshooteptoepsession<sessionname>tracerouteprotocol 48
troubleshooteptoepsession<sessionname>tracerouteprotocoltcpdstport 48
showtroubleshooteptoep 49
showtroubleshooteptoepsession<sessionname> 49
version 50
where 51
Cisco APIC Object Model Command-Line Interface User Guide
v
Contents
Cisco APIC Object Model Command-Line Interface User Guide
vi
Preface
Thisprefaceincludesthefollowingsections:
• Audience, page vii
• DocumentConventions, page vii
• RelatedDocumentation, page ix
• DocumentationFeedback, page ix
Audience
ThisguideisintendedfornetworkandsystemsadministratorswhoconfigureandmaintaintheApplication
CentricInfrastructurefabric.
Document Conventions
Commanddescriptionsusethefollowingconventions:
Convention Description
bold Boldtextindicatesthecommandsandkeywordsthatyouenterliterally
asshown.
Italic Italictextindicatesargumentsforwhichtheusersuppliesthevalues.
[x] Squarebracketsencloseanoptionalelement(keywordorargument).
[x|y] Squarebracketsenclosingkeywordsorargumentsseparatedbyavertical
barindicateanoptionalchoice.
{x|y} Bracesenclosingkeywordsorargumentsseparatedbyaverticalbar
indicatearequiredchoice.
Cisco APIC Object Model Command-Line Interface User Guide
vii
Preface
Document Conventions
Convention Description
[x{y|z}] Nestedsetofsquarebracketsorbracesindicateoptionalorrequired
choiceswithinoptionalorrequiredelements.Bracesandaverticalbar
withinsquarebracketsindicatearequiredchoicewithinanoptional
element.
variable Indicatesavariableforwhichyousupplyvalues,incontextwhereitalics
cannotbeused.
string Anonquotedsetofcharacters.Donotusequotationmarksaroundthe
stringorthestringwillincludethequotationmarks.
Examplesusethefollowingconventions:
Convention Description
screen font Terminalsessionsandinformationtheswitchdisplaysareinscreenfont.
boldface screen font Informationyoumustenterisinboldfacescreenfont.
italicscreenfont Argumentsforwhichyousupplyvaluesareinitalicscreenfont.
<> Nonprintingcharacters,suchaspasswords,areinanglebrackets.
[] Defaultresponsestosystempromptsareinsquarebrackets.
!,# Anexclamationpoint(!)orapoundsign(#)atthebeginningofaline
ofcodeindicatesacommentline.
Thisdocumentusesthefollowingconventions:
Note Meansreadertakenote.Notescontainhelpfulsuggestionsorreferencestomaterialnotcoveredinthe
manual.
Caution Meansreaderbecareful.Inthissituation,youmightdosomethingthatcouldresultinequipmentdamage
orlossofdata.
Cisco APIC Object Model Command-Line Interface User Guide
viii
Preface
Related Documentation
Warning IMPORTANTSAFETYINSTRUCTIONS
Thiswarningsymbolmeansdanger.Youareinasituationthatcouldcausebodilyinjury.Beforeyou
workonanyequipment,beawareofthehazardsinvolvedwithelectricalcircuitryandbefamiliarwith
standardpracticesforpreventingaccidents.Usethestatementnumberprovidedattheendofeachwarning
tolocateitstranslationinthetranslatedsafetywarningsthataccompaniedthisdevice.
SAVETHESEINSTRUCTIONS
Related Documentation
Cisco Application Centric Infrastructure (ACI) Documentation
TheACIdocumentationisavailableatthefollowingURL:http://www.cisco.com/c/en/us/support/
cloud-systems-management/application-policy-infrastructure-controller-apic/
tsd-products-support-series-home.html.
Cisco Application Centric Infrastructure (ACI) Simulator Documentation
TheCiscoACISimulatordocumentationisavailableathttp://www.cisco.com/c/en/us/support/
cloud-systems-management/application-centric-infrastructure-simulator/tsd-products-support-series-home.html.
Cisco Nexus 9000 Series Switches Documentation
TheCiscoNexus9000SeriesSwitchesdocumentationisavailableathttp://www.cisco.com/c/en/us/support/
switches/nexus-9000-series-switches/tsd-products-support-series-home.html.
Cisco Application Virtual Switch Documentation
TheCiscoApplicationVirtualSwitch(AVS)documentationisavailableathttp://www.cisco.com/c/en/us/
support/switches/application-virtual-switch/tsd-products-support-series-home.html.
Cisco Application Centric Infrastructure (ACI) Integration with OpenStack Documentation
CiscoACIintegrationwithOpenStackdocumentationisavailableathttp://www.cisco.com/c/en/us/support/
cloud-systems-management/application-policy-infrastructure-controller-apic/
tsd-products-support-series-home.html.
Documentation Feedback
Toprovidetechnicalfeedbackonthisdocument,ortoreportanerrororomission,pleasesendyourcomments
[e-mail].
Cisco APIC Object Model Command-Line Interface User Guide
ix
Preface
Documentation Feedback
Cisco APIC Object Model Command-Line Interface User Guide
x