Documentation RoadmapsTable of ContentsCisco Elastic Services Controller 2.3 Documentation Overview1Documentation Overview1Documentation List1Obtaining Documentation and Submitting a Service Request2Size: 199 KBPages: 3Language: EnglishOpen manual
Developer's GuideTable of ContentsCisco Elastic Service Controller 2.3 Netconf API Guide11 Introduction41.1 Using NETCONF API41.1.1 Get configuration41.1.2 Get non-configurable data41.1.3 Subscribe ESC notifications41.1.4 Make RPC calls41.1.5 Push in configurations41.2 ConfD CLI41.3 Change ConfD Admin Password41.4 NETCONF Protocol Operations51.5 NETCONF Capabilities62 ESC Datamodel83 Configuration Data83.1 Reading Configuration Data83.1.1 Fetching all config data83.1.1.1 Netconf Request83.1.1.2 Netconf Response93.1.2 Example: Fetching deployed services by network name113.1.2.1 Netconf Request113.1.2.2 Netconf Response113.2 Writing Configuration Data (CRUD operations)123.2.1 Stage 1: Acceptance or Rejection of a Configuration Request123.2.2 Stage 2: Activation of a new Configuration133.2.2.1 Event Notifications133.2.2.2 Operational Data133.2.2.3 Activation Failures133.2.3 Configuration Workflows133.2.4 Combining Workflows134 Operational Data154.1 Reading Operational Data154.1.1 Fetching all operational data154.1.1.1 Netconf Request154.1.1.2 Netconf Response155 Custom RPC Methods175.1 serviceAction method175.2 vmAction method176 ESC Workflows using Netconf176.1 Configuration Workflows176.1.1 Create Vim Connector176.1.1.1 Netconf Request176.1.1.2 Netconf Response186.1.2 Delete Vim Connector186.1.2.1 Netconf Request186.1.2.2 Netconf Response186.1.3 Create Tenant196.1.3.1 Netconf Request196.1.3.2 Netconf Response196.1.3.3 Configuration Activation19On Success:19Event notification19Operational data20Netconf Request20Netconf Response20On Failure:20Event notification20Operational data20Handling Activation Failures206.1.4 Delete Tenant216.1.4.1 Netconf Request216.1.4.2 Netconf Response216.1.4.3 Configuration Activation21On Success:21Event notification21Operational data22On Failure:22Event notification22Operational data22Handling Activation Failures226.1.5 Create Network236.1.5.1 Netconf Request236.1.5.2 Netconf Response236.1.5.3 Configuration Activation23On Success:23Note: attributes ‘vlan_id’, ‘switch_name’ and ‘number_of_ports’ are required for VMware VIM23Event notification23On Failure:24Event notification24Handling Activation Failures246.1.6 Delete Network256.1.6.1 Netconf Request256.1.6.2 Netconf Response256.1.6.3 Configuration Activation25On Success:25Event notification25On Failure:26Event notification26Handling Activation Failures266.1.7 Create Subnet276.1.7.1 Netconf Request276.1.7.2 Netconf Response276.1.7.3 Configuration Activation27On Success:27Event notification27On Failure:28Event notification28Handling Activation Failures286.1.8 Delete Subnet296.1.8.1 Netconf Request296.1.8.2 Netconf Response296.1.8.3 Configuration Activation29On Success:29Event notification29On Failure:30Event notification30Handling Activation Failures306.1.9 Create Image316.1.9.1 Netconf Request316.1.9.2 Netconf Response316.1.9.3 Configuration Activation31On Success:31Event notification31Operational data32Netconf Request32Netconf Response32On Failure:32Event notification32Operational data32Handling Activation Failures326.1.10 Delete Image336.1.10.1 Netconf Request336.1.10.2 Netconf Response336.1.10.3 Configuration Activation33On Success:33Event notification33Operational data33On Failure:34Event notification34Operational data34Handling Activation Failures346.1.11 Create Flavor356.1.11.1 Netconf Request356.1.11.2 Netconf Response356.1.11.3 Configuration Activation35On Success:35Event notification35Operational data36Netconf Request36Netconf Response36On Failure:36Event notification36Operational data36Handling Activation Failures366.1.12 Delete Flavor386.1.12.1 Netconf Request386.1.12.2 Netconf Response386.1.12.3 Configuration Activation38On Success:38Event notification38Operational data38On Failure:39Event notification39Operational data39Handling Activation Failures396.1.13 [DEPRECATED] Register Service with the Service Catalog406.1.13.1 Netconf Request406.1.13.2 Netconf Response406.1.13.3 Configuration Activation41On Success:41Event notification41Operational data41Not applicable. There is no operational data for service registration.41On Failure:41Event notification41Operational data42Not applicable. There is no operational data for service registration.42Handling Activation Failures426.1.14 [DEPRECATED] Unregister Service from the Service Catalog436.1.14.1 Netconf Request436.1.14.2 Netconf Response436.1.14.3 Configuration Activation43On Success:43Event notification43Operational data44Not applicable. There is no operational data for service registration.44On Failure:44Event notification44Operational data44Not applicable. There is no operational data for service registration.44Handling Activation Failures446.1.15 Deploy Service456.1.15.1 Netconf Request456.1.15.2 Netconf Response476.1.15.3 Configuration Activation47Workflow Aggregation:47On Success:48Event notification48Operational data49Netconf Request49Netconf Response50On Failure:51Event notification51Operational data51Handling Activation Failures526.1.16 Un-deploy Service526.1.16.1 Netconf Request526.1.16.2 Netconf Response526.1.16.3 Configuration Activation53Workflow Aggregation:53On Success:53Event notification53Operational data54On Failure:54Event notification54Operational data54Handling Activation Failures546.1.17 Update Service556.1.17.1 Netconf Request556.1.17.2 Netconf Response586.1.17.3 Configuration Activation58On Success:58Event notification58Operational data58Netconf Request58Netconf Response59On Failure:60Event notification60Operational data60Handling Activation Failures606.2 Operational Workflows606.2.1 Service Operations616.2.1.1 Stop Service616.2.1.1.1 Netconf Request616.2.1.1.2 Netconf Response616.2.1.1.3 Event Notifications616.2.1.2 Start Service626.2.1.2.1 Netconf Request626.2.1.2.2 Netconf Response626.2.1.2.3 Event Notifications636.2.1.3 Reboot Service646.2.1.3.1 Netconf Request646.2.1.3.2 Netconf Response646.2.1.3.3 Event Notifications646.2.1.4 Disable Service Monitor666.2.1.4.1 Netconf Request666.2.1.4.2 Netconf Response666.2.1.4.3 Event Notifications666.2.1.5 Enable Service Monitor676.2.1.5.1 Netconf Response686.2.1.5.2 Event Notifications686.2.2 VM operations696.2.2.1 Stop VM696.2.2.1.1 Netconf Request69The “force” option in the request decides if ESC considers the min_vm requirement for the service. Since stopping a VM would affect the service availability, after the VM is stopped the min_vm requirement specified in the datamodel may not be satisfit...696.2.2.1.2 Netconf Response696.2.2.1.3 Event Notifications706.2.2.2 Start VM706.2.2.2.1 Netconf Request706.2.2.2.2 Netconf Response716.2.2.2.3 Event Notifications716.2.2.3 Reboot VM726.2.2.3.1 Netconf Request72The “force” option in the request decides if ESC considers the min_vm requirement for the service. Since stopping a VM would affect the service availability, after the VM is rebooted the min_vm requirement specified in the datamodel may not be satisfi...726.2.2.3.2 Netconf Response726.2.2.3.3 Event Notifications726.2.2.4 Disable VM Monitor746.2.2.4.1 Netconf Request746.2.2.4.2 Netconf Response746.2.2.4.3 Event Notifications746.2.2.5 Enable VM Monitor756.2.2.5.1 Netconf Request756.2.2.5.2 Netconf Response756.2.2.5.3 Event Notifications756.2.2.6 Recovery VM776.2.2.6.1 Netconf Request776.2.2.6.2 Netconf Response776.2.2.6.3 Event Notifications777 ESC Triggered Workflows807.1 Recovery (Healing) Workflow80Recovery Initialize80Attempts for recovery80Recovery complete81Success Event notifications81On Failure:82Event notification82Handling Recovery Failures827.2 Scale Out/Scale in Work Flows837.2.1 Scale Out Work Flow837.2.1.1 Event Notifications837.2.2 Scale In Work Flow847.2.2.1 Event Notifications84Size: 2.13 MBPages: 85Language: EnglishOpen manual
Release NotesTable of ContentsCisco Elastic Services Controller 2.3 Release Notes1Introduction1New Features and Enhancements of 2.31Deprecated Features2Cisco Elastic Services Controller Bugs2Cisco Bug Search Tool3Accessibility Features in Cisco ESC4Related Documentation4Size: 408 KBPages: 5Language: EnglishOpen manual
