Cisco APIC REST API Configuration Guide PDF
Preview Cisco APIC REST API Configuration Guide
Cisco APIC REST API Configuration Guide FirstPublished:2016-10-31 LastModified:2018-05-08 AmericasHeadquarters CiscoSystems,Inc. 170WestTasmanDrive SanJose,CA95134-1706 USA http://www.cisco.com Tel:408526-4000 800553-NETS(6387) Fax:408527-0883 THESPECIFICATIONSANDINFORMATIONREGARDINGTHEPRODUCTSINTHISMANUALARESUBJECTTOCHANGEWITHOUTNOTICE.ALLSTATEMENTS, INFORMATION,ANDRECOMMENDATIONSINTHISMANUALAREBELIEVEDTOBEACCURATEBUTAREPRESENTEDWITHOUTWARRANTYOFANYKIND, EXPRESSORIMPLIED.USERSMUSTTAKEFULLRESPONSIBILITYFORTHEIRAPPLICATIONOFANYPRODUCTS. THESOFTWARELICENSEANDLIMITEDWARRANTYFORTHEACCOMPANYINGPRODUCTARESETFORTHINTHEINFORMATIONPACKETTHATSHIPPEDWITH THEPRODUCTANDAREINCORPORATEDHEREINBYTHISREFERENCE.IFYOUAREUNABLETOLOCATETHESOFTWARELICENSEORLIMITEDWARRANTY, CONTACTYOURCISCOREPRESENTATIVEFORACOPY. TheCiscoimplementationofTCPheadercompressionisanadaptationofaprogramdevelopedbytheUniversityofCalifornia,Berkeley(UCB)aspartofUCB'spublicdomainversionof theUNIXoperatingsystem.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: https://www.cisco.com/go/trademarks.Third-partytrademarksmentionedarethepropertyoftheirrespectiveowners.Theuseofthewordpartnerdoesnotimplyapartnershiprelationship betweenCiscoandanyothercompany.(1721R) ©2016–2018CiscoSystems,Inc.Allrightsreserved. CONTEN TS PREFACE Preface xxi Audience xxi NewandChangedInformation xxi DocumentConventions xxx RelatedDocumentation xxxi DocumentationFeedback xxxi PART I Part1:CiscoAPICRESTAPIUsageGuidelines 33 CHAPTER 1 UsingtheRESTAPI 1 AbouttheRESTAPI 1 AbouttheRESTAPI 1 ManagementInformationModel 2 ObjectNaming 3 ComposingRESTAPIRequests 4 ReadandWriteOperationsandFilters 4 UsingClassesinRESTAPICommands 6 UsingManagedObjectsinRESTAPICommands 6 CreatingtheAPICommand 7 ComposingtheAPICommandBody 9 ComposingtheAPICommandBodytoCallaMethod 10 ComposingtheAPICommandBodyforanAPIOperationonanMO 11 UsingTagsandAlias 12 ComposingRESTAPIQueries 14 ComposingQueryFilterExpressions 14 ApplyingQueryScopingFilters 16 CiscoAPICRESTAPIConfigurationGuide iii Contents FilteringAPIQueryResults 18 FilterConditionalOperators 18 SortingandPaginatingQueryResults 19 SubscribingtoQueryResults 20 RESTAPIExamples 23 InformationAbouttheAPIExamples 23 Example:UsingtheJSONAPItoAddaLeafPortSelectorProfile 23 Example:UsingtheJSONAPItoGetInformationAboutaNode 25 Example:UsingtheJSONAPItoGetRunningFirmware 26 Example:UsingtheJSONAPItoGetTopLevelSystemElements 27 Example:UsingtheXMLAPIandOwnerTagtoAddAuditLogInformationtoActions 29 Example:XMLGetEndpoints(Devices)withIPandMACAddresses 29 Example:MonitoringUsingtheRESTAPI 30 AccessingtheRESTAPI 30 AccessingtheRESTAPI 30 InvokingtheAPI 31 ConfiguringtheHTTPRequestMethodandContentType 31 ConfiguringHTTPandHTTPSUsingtheGUI 32 ConfiguringaCustomCertificateforCiscoACIHTTPSAccessUsingtheGUI 32 AuthenticatingandMaintaininganAPISession 34 RequiringaChallengeTokenforanAPISession 36 LoggingIn 37 ChangingYourOwnUserCredentials 37 RESTAPITools 39 ManagementInformationModelReference 39 ViewinganAPIInterchangeintheGUI 40 TestingtheAPIUsingBrowserAdd-Ons 42 TestingtheAPIwithcURL 42 CiscoAPICPythonSDK 43 UsingtheManagedObjectBrowser(Visore) 43 VisoreBrowserPage 43 AccessingVisore 45 RunningaQueryinVisore 45 CiscoAPICRESTAPIConfigurationGuide iv Contents PART II Part2:CommonAPICTasksUsingtheRESTAPI 47 CHAPTER 2 ManagingAPICUsingtheRESTAPI 49 AddingManagementAccess 49 In-BandandOut-of-BandManagementAccess 49 AboutStaticManagementAccess 49 ConfiguringIn-BandManagementAccessUsingtheRESTAPI 50 ConfiguringStaticIn-BandManagementAccessUsingtheRESTAPI 51 ConfiguringOut-of-BandManagementAccessUsingtheRESTAPI 53 ConfiguringStaticOut-of-BandManagementAccessUsingtheRESTAPI 55 ManagingConfigurationFiles 56 Overview 56 BackingUp,Restoring,andRollingBackConfigurationFilesWorkflow 57 AboutConfigurationExporttoControllers 58 AboutConfigurationImporttoController 58 ConfigurationFileEncryption 60 AboutthefileRemotePathObject 61 ConfiguringaRemoteLocationUsingtheRESTAPI 61 ConfiguringConfigurationFileExporttoControllerUsingtheRESTAPI 61 ConfiguringaConfigurationFileImportPolicyUsingtheRESTAPI 62 EncryptingConfigurationFilesUsingtheRESTAPI 62 SnapshotsandRollbacks 63 Snapshots 63 AboutRollbacks 63 UploadingandDownloadingSnapshotsUsingtheRESTAPI 64 ConfiguringandExecutingaConfigurationRollbackUsingtheRESTAPI 65 UsingConfigurationZones 65 ConfigurationZones 65 ConfigurationZoneSupportedPolicies 66 CreatingConfigurationZonesUsingtheRESTAPI 68 CHAPTER 3 ManagingRoles,Users,andSignature-BasedTransactions 71 ManagingAPICRolesandUsers 71 CiscoAPICRESTAPIConfigurationGuide v Contents UserAccess,Authorization,andAccounting 71 Accounting 71 MultipleTenantSupport 72 UserAccess:Roles,Privileges,andSecurityDomains 72 ConfiguringaCustomRoleUsingtheRESTAPI 74 ConfiguringaLocalUser 74 ConfiguringaLocalUserUsingtheRESTAPI 75 ConfiguringaRemoteUser 75 ConfiguringaRemoteUserUsingtheRESTAPI 75 APICSignature-BasedTransactions 76 AboutSignature-BasedTransactions 76 UsingaPrivateKeytoCalculateaSignature 76 GuidelinesandLimitations 78 CreatingaLocalUserandAddingaUserCertificateUsingtheRESTAPI 78 CHAPTER 4 CommonTenantTasks 81 CommonTenantTasks 81 TenantsOverview 81 TenantCreation 81 AddingaTenant 81 Example:UsingtheJSONAPItoAddaTenant 82 Example:UsingtheXMLAPItoAddaTenant 83 CHAPTER 5 ManagingLayer2Networking 85 TenantExternalBridgedNetworks 85 BridgedInterfacetoanExternalRouter 85 VRFandBridgeDomains 85 CreatingaTenant,VRF,andBridgeDomainUsingtheRESTAPI 86 Ports 86 StaticallyDeployinganEPGonaSpecificPort 86 DeployinganEPGonaSpecificPortwithAPICUsingtheRESTAPI 86 CreatingDomains,AttachEntityProfiles,andVLANstoDeployanEPGonaSpecificPort 87 CreatingAEP,Domains,andVLANstoDeployanEPGonaSpecificPortUsingtheRESTAPI 88 CiscoAPICRESTAPIConfigurationGuide vi Contents CreatingaPortChannelPolicyUsingtheRESTAPI 89 CHAPTER 6 ManagingLayer3Networking 91 ConfiguringExternalConnectivityforTenants 91 ConfiguringaTenantLayer3OutsideNetworkConnectionOverview 91 ConfiguringLayer3OutsideforTenantNetworksUsingtheRESTAPI 92 ConfiguringBGPMaxPath 95 ConfiguringBGPMaxPathUsingtheRESTAPI 95 ConfiguringASPathPrepend 95 ConfiguringASPathPrependUsingtheRESTAPI 96 ConfiguringBFD 96 ConfiguringBFDGloballyUsingtheRESTAPI 96 ConfiguringBFDInterfaceOverrideUsingtheRESTAPI 97 ConfiguringBFDConsumerProtocolsUsingtheRESTAPI 97 CHAPTER 7 MonitoringUsingtheRESTAPI 101 AboutMonitoringUsingtheRESTAPI 101 MonitoringAPICUsingtheRESTAPI 101 APIC 101 MonitoringAPICCPUandMemoryUsageUsingtheRESTAPI 101 MonitoringAPICDiskUtilizationUsingtheRESTAPI 102 MonitoringPhysicalInterfaceStatisticsandLinkStateUsingtheRESTAPI 102 Fabric 103 MonitoringLLDPandCDPNeighborStatusUsingtheRESTAPI 103 MonitoringPhysicalandBondInterfacesUsingtheRESTAPI 103 MonitoringEPG-LevelStatisticsUsingtheRESTAPI 104 Switches 104 MonitoringSwitchCPUUtilizationUsingtheRESTAPI 104 MonitoringSwitchFanStatusUsingtheRESTAPI 105 MonitoringSwitchMemoryUtilizationUsingtheRESTAPI 105 MonitoringSwitchModuleStatusUsingtheRESTAPI 106 MonitoringSwitchPowerSupplyStatusUsingtheRESTAPI 106 MonitoringSwitchInventoryUsingtheRESTAPI 107 ExternalMonitoring 107 CiscoAPICRESTAPIConfigurationGuide vii Contents SmartCallhome 107 AboutSmartCallhome 107 CreatingaSmartCallhomeDestinationGroupUsingtheRESTAPI 108 TACACSExternalLogging 109 AboutTACACSExternalLogging 109 CreatingaTACACSExternalLoggingDestinationGroupUsingtheRESTAPI 109 CreatingaTACACSExternalLoggingSourceUsingtheRESTAPI 110 CHAPTER 8 TroubleshootingUsingtheRESTAPI 111 CollectingandExportingTechnicalSupportInformation 111 AboutExportingFiles 111 SendinganOn-DemandTechSupportFileUsingtheRESTAPI 111 TroubleshootingUsingAtomicCounters 112 AtomicCounters 112 EnablingAtomicCounters 113 AboutFabricLatency 114 AboutPTP 116 TroubleshootingUsingAtomicCounterswiththeRESTAPI 118 ConfiguringLatencyandPTPUsingtheRESTAPI 118 TroubleshootingUsingFaults 119 UnderstandingAPICFaults 119 TroubleshootingUsingFaultswiththeRESTAPI 120 Statistics 122 ConfiguringaStatsMonitoringPolicyUsingtheRESTAPI 122 RecoveringaDisconnectedLeaf 123 RecoveringaDisconnectedLeaf 123 RecoveringaDisconnectedLeafUsingtheRESTAPI 123 TroubleshootingContractsandTabooContractswithPermitandDenyLogging 124 VerifyingContracts,TabooContracts,andFiltersUsingtheRESTAPI 124 ViewingACLPermitandDenyLogsUsingtheRESTAPI 124 TroubleshootingUsingDigitalOpticalMonitoringStatistics 126 TroubleshootingUsingDigitalOpticalMonitoringWiththeRESTAPI 126 TroubleshootingUsingPortTracking 127 PortTrackingPolicyforUplinkFailureDetection 127 CiscoAPICRESTAPIConfigurationGuide viii Contents PortTrackingUsingtheRESTAPI 127 RemovingUnwanted_ui_Objects 128 RemovingUnwanted_ui_ObjectsUsingtheRESTAPI 128 TroubleshootingUsingContractPermitandDenyLogs 129 AboutACLContractPermitandDenyLogs 129 EnablingACLContractPermitLoggingUsingtheRESTAPI 129 EnablingTabooContractDenyLoggingUsingtheRESTAPI 130 ViewingACLPermitandDenyLogsUsingtheRESTAPI 130 PART III Part3:SettingUpAPICandtheFabricUsingtheRESTAPI 133 CHAPTER 9 ManagingAPICClusters 135 ClusterManagementGuidelines 135 ClusterManagementGuidelines 135 ExpandingandContractingClusters 136 ExpandingtheAPICClusterSize 136 ExpandingtheCiscoAPICCluster 137 ExpandingtheAPICClusterUsingtheRESTAPI 137 ContractingtheCiscoAPICCluster 137 ContractingtheAPICClusterUsingtheRESTAPI 137 CHAPTER 10 ManagingFabrics 139 MaintenanceMode 139 RemovingaSwitchtoMaintenanceModeUsingtheRESTAPI 140 InsertingaSwitchtoOperationModeUsingCLI 141 CHAPTER 11 ConfiguringTenantPolicies 143 BasicTenantConfiguration 143 CreatingaTenant,VRF,andBridgeDomainUsingtheRESTAPI 143 TenantsinMultiplePrivateNetworks 144 AboutMultiplePrivateNetworkswithInter-TenantCommunication 144 ConfiguringMultiplePrivateNetworkswithInter-TenantCommunicationUsingtheRESTAPI 145 AboutMultiplePrivateNetworkswithIntra-TenantCommunication 146 CiscoAPICRESTAPIConfigurationGuide ix Contents ConfiguringMultipleTenantswithIntra-TenantCommunicationUsingtheRESTAPI 147 TenantPolicyExample 148 TenantPolicyExampleOverview 148 TenantPolicyExampleXMLCode 148 TenantPolicyExampleExplanation 150 PolicyUniverse 150 TenantPolicyExample 150 Filters 150 Contracts 152 Subjects 152 Labels 153 VRF 153 BridgeDomains 154 ApplicationProfiles 154 EndpointsandEndpointGroups(EPGs) 155 Closing 156 WhattheExampleTenantPolicyDoes 156 EPGs 158 DeployinganApplicationEPGthroughanAEPorInterfacePolicyGrouptoMultiplePorts 158 DeployinganEPGonaSpecificPortwithAPICUsingtheRESTAPI 158 DeployinganEPGthroughanAEPtoMultipleInterfacesUsingtheRESTAPI 159 CreatingAEP,Domains,andVLANstoDeployanEPGonaSpecificPortUsingtheRESTAPI 160 Intra-EPGIsolation 161 Intra-EPGIsolationforBareMetalServers 161 ConfiguringIntra-EPGIsolationforBareMetalServersUsingtheRESTAPI 162 Intra-EPGIsolationforVMwareVDSorMicrosoftvSwitch 163 ConfiguringIntra-EPGIsolationforVMwareVDSorMicrosoftvSwitchusingtheRESTAPI 165 Intra-EPGIsolationEnforcementforCiscoAVS 165 ConfiguringIntra-EPGIsolationforCiscoAVSUsingtheRESTAPI 166 Microsegmentation 167 UsingMicrosegmentationwithNetwork-basedAttributesonBareMetal 167 ConfiguringanIP-basedMicrosegmentedEPGasaSharedResourceUsingtheRESTAPI 167 CiscoAPICRESTAPIConfigurationGuide x
Description:The list of books you might like
