Cisco APIC Layer 4 to Layer 7 Device Package Development Guide

90 Pages·2015·3.03 MB·English

Cisco APIC Layer 4 to Layer 7 Device Package Development Guide
First Published: October31,2013
Last Modified: October14,2014
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.
CiscoandtheCiscologoaretrademarksorregisteredtrademarksofCiscoand/oritsaffiliatesintheU.S.andothercountries.ToviewalistofCiscotrademarks,gotothisURL:http://
www.cisco.com/go/trademarks.Third-partytrademarksmentionedarethepropertyoftheirrespectiveowners.Theuseofthewordpartnerdoesnotimplyapartnership
relationshipbetweenCiscoandanyothercompany.(1110R)
©2014CiscoSystems,Inc.Allrightsreserved.
CONTENTS
Preface Preface vii
Audience vii
DocumentConventions vii
RelatedDocumentation ix
DocumentationFeedback x
ObtainingDocumentationandSubmittingaServiceRequest x
CHAPTER 1 Overview 1
AboutServiceIntegrationwiththeApplicationPolicyInfrastructureController 1
AbouttheDevicePackageArchitecture 3
AbouttheDebugLogs 4
CHAPTER 2 DevelopingDeviceSpecifications 5
AboutDeviceTypes 5
AboutDeviceSpecifications 6
DeviceScript 8
DevicesCredentials 9
InterfaceLabels 9
AboutClusterandDeviceConfigurations 10
ClusterConfigurations 10
DeviceConfigurations 11
AboutFunctionalConfigurations 11
ConnectorObjects 12
Images 14
FunctionConfigurations 14
GroupConfigurations 15
GlobalFunctionConfigurations 16
Cisco APIC Layer 4 to Layer 7 Device Package Development Guide
iii
Contents
Relations 16
ParameterScopeandAPIConfigurationDictionary 18
AboutParameterObjectsandFolders 18
ParameterObjects 18
Folders 20
ParameterValidation 22
FaultsCodes 24
FunctionProfile 25
ManagedObjectModel 28
ManagedObjectExample 32
CHAPTER 3 DevelopingDeviceScripts 37
AboutDeviceScripts 37
GuidelinesforCreatingDeviceScripts 38
DeviceScriptAPIs 38
ScriptFramework 40
ConfigurationDictionaryFormat 41
ServiceConfiguration 44
APICallouts 45
PassingParameters 48
DeviceIdentification 49
HandlingScriptFailures 50
SampleScript 51
CHAPTER 4 FabricConnectivity 65
AboutFabricConnectivity 65
RegisteringDevices 65
Connectors 67
ServiceGraphs 67
GraphRendering 68
DeviceScriptInterface 69
CHAPTER 5 ServiceInsertionSupport 73
AboutServiceInsertionSupport 73
HealthMonitoring 73
Cisco APIC Layer 4 to Layer 7 Device Package Development Guide
iv
Contents
Faults 76
Counters 78
Cisco APIC Layer 4 to Layer 7 Device Package Development Guide
v
Contents
Cisco APIC Layer 4 to Layer 7 Device Package Development Guide
vi
Preface
Thisprefaceincludesthefollowingsections:
• Audience, page vii
• DocumentConventions, page vii
• RelatedDocumentation, page ix
• DocumentationFeedback, page x
• ObtainingDocumentationandSubmittingaServiceRequest, page x
Audience
Thisguideisintendedprimarilyfordatacenteradministratorswithresponsibilitiesandexpertiseinoneor
moreofthefollowing:
•Virtualmachineinstallationandadministration
•Serveradministration
•Switchandnetworkadministration
Document Conventions
Commanddescriptionsusethefollowingconventions:
Convention Description
bold Boldtextindicatesthecommandsandkeywordsthatyouenterliterally
asshown.
Italic Italictextindicatesargumentsforwhichtheusersuppliesthevalues.
[x] Squarebracketsencloseanoptionalelement(keywordorargument).
Cisco APIC Layer 4 to Layer 7 Device Package Development Guide
vii
Preface
Document Conventions
Convention Description
[x|y] Squarebracketsenclosingkeywordsorargumentsseparatedbyavertical
barindicateanoptionalchoice.
{x|y} Bracesenclosingkeywordsorargumentsseparatedbyaverticalbar
indicatearequiredchoice.
[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 Layer 4 to Layer 7 Device Package Development Guide
viii
Preface
Related Documentation
Warning IMPORTANTSAFETYINSTRUCTIONS
Thiswarningsymbolmeansdanger.Youareinasituationthatcouldcausebodilyinjury.Beforeyou
workonanyequipment,beawareofthehazardsinvolvedwithelectricalcircuitryandbefamiliarwith
standardpracticesforpreventingaccidents.Usethestatementnumberprovidedattheendofeachwarning
tolocateitstranslationinthetranslatedsafetywarningsthataccompaniedthisdevice.
SAVETHESEINSTRUCTIONS
Related Documentation
TheApplicationCentricInfrastructuredocumentationsetincludesthefollowingdocuments:
Web-Based Documentation
•CiscoAPICManagementInformationModelReference
•CiscoAPICOnlineHelpReference
•CiscoACIMIBSupportList
Downloadable Documentation
•CiscoApplicationCentricInfrastructureReleaseNotes
•CiscoApplicationCentricInfrastructureFundamentalsGuide
•CiscoAPICGettingStartedGuide
•CiscoAPICRESTAPIUserGuide
•CiscoAPICCommandLineInterfaceUserGuide
•CiscoAPICFaults,Events,andSystemMessageGuide
•CiscoAPICLayer4toLayer7DevicePackageDevelopmentGuide
•CiscoAPICLayer4toLayer7ServicesDeploymentGuide
•CiscoACIFirmwareManagementGuide
•CiscoACITroubleshootingGuide
•CiscoACINX-OSSyslogReferenceGuide
•CiscoACISwitchCommandReference,NX-OSRelease11.0
•CiscoACIMIBQuickReference
•CiscoNexusCLItoCiscoAPICMappingGuide
•InstallingtheCiscoApplicationVirtualSwitchwiththeCiscoAPIC
•ConfiguringtheCiscoApplicationVirtualSwitchusingtheCiscoAPIC
•ApplicationCentricInfrastructureFabricHardwareInstallationGuide
Cisco APIC Layer 4 to Layer 7 Device Package Development Guide
ix
Preface
Documentation Feedback
Documentation Feedback
Toprovidetechnicalfeedbackonthisdocument,ortoreportanerrororomission,pleasesendyourcomments
[email protected].
Obtaining Documentation and Submitting a Service Request
Forinformationonobtainingdocumentation,usingtheCiscoBugSearchTool(BST),submittingaservice
request,andgatheringadditionalinformation,seeWhat'sNewinCiscoProductDocumentationat:http://
www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html
SubscribetoWhat’sNewinCiscoProductDocumentation,whichlistsallnewandrevisedCiscotechnical
documentationasanRSSfeedanddeliverscontentdirectlytoyourdesktopusingareaderapplication.The
RSSfeedsareafreeservice.
Cisco APIC Layer 4 to Layer 7 Device Package Development Guide
x