ESC ETSI API 5.2.0 OAS3 - Cisco

3y ago
54 Views
4 Downloads
883.59 KB
51 Pages
Last View : 18d ago
Last Download : 3m ago
Upload by : Kian Swinton
Transcription

Swagger UI18/05/2020, 16:34swaggerExplore/esc-etsi-apiESC ETSI API5.2.0OAS3/esc-etsi-apiDocumentation :ETSI-MANO REST Northbound APIThis REST API is another programmatic interface to ESC that uses a REST architecture. The APIaccepts and returns HTTP or HTTPS messages that contain JavaScript Object Notation (JSON).It is the payloads for these request/responses that a de!ned by the European TelecommunicationsStandards Institute (ETSI), speci!cally around Management and Orchestration (MANO). It contains itsown data model, designed around the ETSI-MANO speci!cation (ETSI GS NFV-SOL 003 V2.4.1), thatabstracts away from the ESC core data model.This initial implementation of the ETSI-MANO standards for NFV is to address the Or-Vnfm referencepoint, i.e. the interface between the Network Function Virtualisation Orchestrator (NFVO) and theVirtual Network Function Manager (VNFM).The Or-Vnfm reference point to details the interactions to onboard ETSI-compliant VNF packages,manage resources, and VNF lifecycle management (LCM) operations.During the lifespan of a VNF Instance, it moves between INSTANTIATED and NOT INSTANTIATEDstates, whereas operations that perform LCM operations have a more complex state machine, as perthe diagram below.The ETSI-MANO speci!cation considers provisioning of many components of a network serviceoutside the remit of the VNFM, namely:TenantsImagesFlavoursExternal Networks/Virtual LinkExternally Managed Internal Virtual LinkSubnetsThis means that LCM operations on an instance of a VNF submitted to the ETSI-MANO REST APIexpect these resources to be created out-of-band (OOB) as far as the VNFM is concerned. It is likelythat these resources are created via the NVFO, either at the time of onboarding the VNF package oronboarding the tenant, and will be represented by VIM (Virtual Infrastructure Manager) identi!ers inthe request to l?url /esc-etsi-api&validatorUrl #/Page 1 of 51

Swagger UI18/05/2020, 16:34Managing ResourcesManaging Resources via the ETSI-MANO API The ETSI-MANO API communicates with NFVO forlifecycle management. A con!guration template, the Virtual Network Function Descriptor (VNFD) !ledescribes the deployment parameters and operational behaviors of a VNF type. The VNFD is used inthe process of deploying a VNF and managing the lifecycle of a VNF instance. The "ow of operationsto deploy a VNF instance is:1. Create VNF Identi!er2. Instantiate VNF The "ow of operations to fully undeploy (and release resources used by a VNFinstance) is:3. Terminate VNF4. Delete VNF Identi!erThe other LCM operations are applicable once the VNF has been instantiated, except from Querywhich is applicable at any time since it does not modify the VNF.LCM OperationsHere is an overview of the operations that can a#ect a VNF instance.Create VNF Identi!er: Generate a new VNF Instance Id (a universally unique identi!er) that issubsequently used as a handle to reference the instance upon which to execute furtheroperations.Instantiate VNF: Deploy a new VNF instance in the VIM. The Instantiate request will containinstance-speci!c values and this, coupled with the VNFD and the Grant information willprovide all the information required by the VIM to deploy the VNF. The VNFD is retrieved fromthe NFVO as part of this call "ow which provides the resource requirements for the VNF to beinstantiated. This data set is then further supplemented by requesting permission from theNFVO to continue with the request which returns Grant information that converts some ofthese resource requirements to actual resources that are reserved in the VIM.Operate VNF: Allow a VNF instance to be started or stopped. The resources are not releasedor changed, but the VNF instance in the VIM is toggled between these two states.Query VNF: Query one or more VNF instances known to ESC. This is a speci!c REST endpointthat can be !ltered to !nd speci!c instances. In this initial release, the instances can be !lteredby the VNF Instance Id.Scale VNF: Scale VNF instance incrementally.Scale VNF to Level: Scale VNF instance to target level.Terminate VNF: Undeploy the VNF instance in the VIM. The resources themselves remainreserved for the VNF instance, however the VNF itself is undeployed.Delete VNF Identi!er: The resources are fully released in the VIM and in ESC and theassociated VNF instance identifer is also released.Heal VNF: Recover a VNF.Modify VNF: Modify a VNF resource.Change External VNF Connectivity: Change the deployment "avour of a VNF instance.Change VNF Flavour: Change the deployment "avour of a VNF x.html?url /esc-etsi-api&validatorUrl #/Page 2 of 51

Swagger UI18/05/2020, 16:34Authentication: At the time of publication, only Basic Authentication is supported using the ETSISwagger API. Cisco ESC does support OAUTH 2.0 authentication. Please see the user guide fordetails.Attribute Selectors: REST endpoints which are used to query multiple results support attributeselectors (see the ETSI-MANO speci!cation for more details).all !elds: This URI query parameter requests that all complex attributes are included in theresponse, including those suppressed by exclude default. It is inverse to the "exclude default"parameter.!elds: This URI query parameter requests that only the listed complex attributes are includedin the response.exclude !elds: This URI query parameter requests that the listed complex attributes areexcluded from the response.exclude default: Presence of this URI query parameter requests that a default set of complexattributes shall be excluded from the response.If no attribute selector is supplied then the default behaviour is the same as exclude default (this canbe changed to all !elds by setting the property attribute.selector.default.all fields totrue).ServerOr-Vnfm vnf instancesGETPOSTGETThis resource represents VNF instances for the OrVnfm Referrence Point. The client can use thisresource to create individual VNF instanceresources, and to query VNF instances./or vnfm/vnflcm/v1/vnf instances Query multiple VNF instances/or vnfm/vnflcm/v1/vnf instances Create a VNF Instance resource/or vnfm/vnflcm/v1/vnf /swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Read anindividualVNF resourcePage 3 of 51

Swagger UIPATCHDELETE18/05/2020, 16:34/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}Modify anindividualVNF Instance/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}Delete a VNFinstanceresourcePOST/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/i Instantiatea VNFnstantiatePOST/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/opa VNFerateInstancePOST/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/scVNFaleInstancePOST/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/sc VNFInstanceale to levelOperateScale aScale ato LevelTerminatePOST/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/ta VNFerminateInstancePOST/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/heVNFalInstancePOST/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/ externalVNFchange ext connHeal aChange theconnectivityChangePOST/or vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/cha theVNFnge flavourFlavourVe-Vnfm vnf instancesThis resource represents VNF instances for theVe-Vnfm Referrence Point. The client can use l?url /esc-etsi-api&validatorUrl #/Page 4 of 51

Swagger UI18/05/2020, 16:34Ve-Vnfm vnf instancesGETPOSTGETPATCHDELETEresource to create individual VNF instanceresources, and to query VNF instances./ve vnfm/vnflcm/v1/vnf instances Query multiple VNF instances/ve vnfm/vnflcm/v1/vnf instances Create a VNF Instance resource/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}Read anindividualVNF resource/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}Modify anindividualVNF Instance/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}Delete a VNFinstanceresourcePOST/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/i Instantiatea VNFnstantiatePOST/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/opa VNFerateInstancePOST/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/scVNFaleInstancePOST/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/scale to levelScale aVNFInstanceto LevelPOST/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/ta VNFerminateInstancePOST/ve vnfm/vnflcm/v1/vnf ale ex.html?url /esc-etsi-api&validatorUrl #/Heal aPage 5 of 51

Swagger UI18/05/2020, 16:34POSTPOST/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/change ext conn/ve vnfm/vnflcm/v1/vnf instances/{vnfInstanceId}/change flavourvnf instancesGETPOSTGETChange theexternalVNFconnectivityChangetheVNFFlavourThis resource represents VNF instances. The client can use thisresource to create individual VNF instance resources, and toquery VNF instances./vnflcm/v1/vnf instances Query multiple VNF instances/vnflcm/v1/vnf instances Create a VNF Instance resource/vnflcm/v1/vnf instances/{vnfInstanceId}Read an individual VNFresourceModify an individual VNFPATCH/vnflcm/v1/vnf instances/{vnfInstanceId} InstanceDELETE/vnflcm/v1/vnf instances/{vnfInstanceId} resourceDelete a VNF instancePOST/vnflcm/v1/vnf instances/{vnfInstanceId}/instantia Instantiatea VNFtePOST/vnflcm/v1/vnf instances/{vnfInstanceId}/operate VNF InstancePOST/vnflcm/v1/vnf instances/{vnfInstanceId}/scale InstancePOST/vnflcm/v1/vnf instances/{vnfInstanceId}/scale to l VNFInstanceevelOperate aScale a VNFScale ato ml?url /esc-etsi-api&validatorUrl #/Page 6 of 51

Swagger UI18/05/2020, 16:34Terminatea VNFInstancePOST/vnflcm/v1/vnf vnf instances/{vnfInstanceId}/heal InstancePOSTPOSTHeal a VNF/vnflcm/v1/vnf instances/{vnfInstanceId}/change ext conn/vnflcm/v1/vnf instances/{vnfInstanceId}/change flavourvnf instances extensionsGETPOSTChange theexternalVNFconnectivityChangetheVNFFlavourThis resource represents extensions to VNFinstances./vnflcm/v1/ext/vnf /vnf st:8250/API/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Extensionendpoint togetdeploymentdescriptorEnable/disablemonitoring orrebootVNF/particularVMsPage 7 of 51

Swagger UI18/05/2020, 16:34Or-Vnfm vnf lcm op occsGETGETPOSTPOSTPOSTPOSTThis resource represents VNF lifecyclemanagement operation occurrences for theOr-Vnfm Rreferrence Point. The client canuse this resource to query statusinformation about multiple VNF lifecyclemanagement operation occurrences./or vnfm/vnflcm/v1/vnf lcm op occsQuery multiple VNF lifecyclemanagement operationoccurrences/or vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}Read anindividualVNF lifecyclemanagementoperationoccurrence/or vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/failMark a VNFlifecyclemanagementoperationoccurrenceas failed/or vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/rollbackRollback aVNF lifecyclemanagementoperationoccurrence/or vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/retryRetry a VNFlifecyclemanagementoperationoccurrence/or vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/cancelCancel a calhost:8250/API/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Page 8 of 51

Swagger UI18/05/2020, 16:34Ve-Vnfm vnf lcm op occsGETGETPOSTPOSTPOSTPOSTThis resource represents VNF lifecyclemanagement operation occurrences for theVe-Vnfm Rreferrence Point. The client canuse this resource to query statusinformation about multiple VNF lifecyclemanagement operation occurrences./ve vnfm/vnflcm/v1/vnf lcm op occsQuery multiple VNF lifecyclemanagement operationoccurrences/ve vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}Read anindividualVNF lifecyclemanagementoperationoccurrence/ve vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/failMark a VNFlifecyclemanagementoperationoccurrenceas failed/ve vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/rollbackRollback aVNF lifecyclemanagementoperationoccurrence/ve vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/retryRetry a VNFlifecyclemanagementoperationoccurrence/ve vnfm/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/cancelCancel a calhost:8250/API/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Page 9 of 51

Swagger UI18/05/2020, 16:34vnf lcm op occsGETGETPOSTPOSTPOSTPOSTThis resource represents VNF lifecycle managementoperation occurrences. The client can use this resource toquery status information about multiple VNF lifecyclemanagement operation occurrences.Query multiple VNF lifecycle management/vnflcm/v1/vnf lcm op occs operation occurrences/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}Read an individual VNFlifecycle managementoperation occurrence/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/fail/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/rollback/vnflcm/v1/vnf lcm op occs/{vnfLcmOpOccId}/retry/vnflcm/v1/vnf lcm op PI/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Mark a VNFlifecyclemanagementoperationoccurrence asfailedRollback aVNF lifecyclemanagementoperationoccurrenceRetry a VNFlifecyclemanagementoperationoccurrenceCancel a VNFlifecyclemanagementoperationoccurrencePage 10 of 51

Swagger UI18/05/2020, 16:34Or-Vnfm lccn subscriptionsGETPOSTGETDELETEThis resource represents VNF lifecyclemanagement noti!cation subscriptions forthe Or-Vnfm Referrence Point. The clientcan use this resource to subscribe tonoti!cations related to VNF lifecyclemanagement, and to query itssubscriptions./or vnfm/vnflcm/v1/subscriptionsQueries the list of active VNF lifecyclemanagement subscriptions/or vnfm/vnflcm/v1/subscriptions Create a new subscription/or vnfm/vnflcm/v1/subscriptions/{subscriptionId}Read anindividualVNF lifecyclemanagementsubscriptionresource/or nate anindividualVNF 50/API/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Page 11 of 51

Swagger UI18/05/2020, 16:34Ve-Vnfm lccn subscriptionsGETPOSTGETDELETEThis resource represents VNF lifecyclemanagement noti!cation subscriptions forthe Ve-Vnfm Referrence Point. The clientcan use this resource to subscribe tonoti!cations related to VNF lifecyclemanagement, and to query itssubscriptions./ve vnfm/vnflcm/v1/subscriptionsQueries the list of active VNF lifecyclemanagement subscriptions/ve vnfm/vnflcm/v1/subscriptions Create a new subscription/ve vnfm/vnflcm/v1/subscriptions/{subscriptionId}Read anindividualVNF lifecyclemanagementsubscriptionresource/ve nate anindividualVNF 50/API/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Page 12 of 51

Swagger UI18/05/2020, 16:34lccn subscriptionsGETPOSTGETDELETEThis resource represents VNF lifecycle managementnoti!cation subscriptions. The client can use thisresource to subscribe to noti!cations related to VNFlifecycle management, and to query its subscriptions.Queries the list of active VNF lifecycle management/vnflcm/v1/subscriptions subscriptions/vnflcm/v1/subscriptions Create a new Id}Read an individual VNFlifecycle managementsubscription erminate an individualVNF 50/API/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Page 13 of 51

Swagger UI18/05/2020, 16:34Or-Vnfm fm subscriptionsGETPOSTGETDELETEThis resource represents VNF alarmsubscriptions for the Or-Vnfm ReferrencePoint. The client can use this resource tosubscribe to noti!cations related to VNFalarms and to query its subscriptions.Queries the list of active VNF alarm/or vnfm/vnffm/v1/subscriptions subscriptions/or vnfm/vnffm/v1/subscriptions Create a new VNF alarm subscription/or vnfm/vnffm/v1/subscriptions/{subscriptionId}Read anindividualVNF alarmsubscriptionresource/or ate anindividualVNF -ui/index.html?url /esc-etsi-api&validatorUrl #/Page 14 of 51

Swagger UI18/05/2020, 16:34Ve-Vnfm fm subscriptionsGETPOSTGETDELETEQueries the list of active VNF alarm/ve vnfm/vnffm/v1/subscriptions subscriptions/ve vnfm/vnffm/v1/subscriptions Create a new VNF alarm subscription/ve vnfm/vnffm/v1/subscriptions/{subscriptionId}Read anindividualVNF alarmsubscriptionresource/ve ate anindividualVNF alarmsubscriptionfm subscriptionsGETPOSTGETDELETEThis resource represents VNF alarmsubscriptions for the Ve-Vnfm ReferrencePoint. The client can use this resource tosubscribe to noti!cations related to VNFalarms and to query its subscriptions.This resource represents VNF alarm subscriptions. Theclient can use this resource to subscribe to noti!cationsrelated to VNF alarms and to query its subscriptions./vnffm/v1/subscriptions Queries the list of active VNF alarm subscriptions/vnffm/v1/subscriptions Create a new VNF alarm d}Read an individual VNFalarm subscriptionresourceTerminate an individual/vnffm/v1/subscriptions/{subscriptionId} VNF alarm ndex.html?url /esc-etsi-api&validatorUrl #/Page 15 of 51

Swagger UI18/05/2020, 16:34Or-Vnfm pm subscriptionsGETPOSTGETDELETEThis resource represents VNF performancesubscriptions for the Or-Vnfm ReferrencePoint. The client can use this resource tosubscribe to noti!cations related to VNFperformance and to query its subscriptions./or vnfm/vnfpm/v1/subscriptionsQueries the list of active VNFperformance subscriptionsCreate a new VNF performance/or vnfm/vnfpm/v1/subscriptions subscription/or vnfm/vnfpm/v1/subscriptions/{subscriptionId}Read anindividualVNFperformancesubscriptionresource/or ate host:8250/API/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Page 16 of 51

Swagger UI18/05/2020, 16:34Ve-Vnfm pm subscriptionsGETPOSTGETDELETEThis resource represents VNF performancesubscriptions for the Ve-Vnfm ReferrencePoint. The client can use this resource tosubscribe to noti!cations related to VNFperformance and to query its subscriptions.Queries the list of active VNF/ve vnfm/vnfpm/v1/subscriptions performance subscriptionsCreate a new VNF performance/ve vnfm/vnfpm/v1/subscriptions subscription/ve vnfm/vnfpm/v1/subscriptions/{subscriptionId}Read anindividualVNFperformancesubscriptionresource/ve ate host:8250/API/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/Page 17 of 51

Swagger UI18/05/2020, 16:34pm subscriptionsGETPOSTGETDELETEalarmsThis resource represents VNF performance subscriptions.The client can use this resource to subscribe tonoti!cations related to VNF performance and to query itssubscriptions./vnfpm/v1/subscriptionsQueries the list of active VNF performancesubscriptions/vnfpm/v1/subscriptions Create a new VNF performance d}Read an individual VNFperformance riptionId}Terminate an individualVNF performancesubscriptionThese are all the resources and methods provided for the VNF faultmanagement interface.GET/vnffm/v1/alarms Get all alarm resourceGET/vnffm/v1/alarms/{alarmId} Get an individual alarm lhost:8250/API/swagger-ui/index.html?url /esc-etsi-api&validatorUrl #/This can be used to change theacknowledgement status of an alarmPage 18 of 51

Swagger UI18/05/2020, 16:34pm jobsGETPOSTGETDELETEGETPOSTThese are

It is the payloads for these request/responses that a de!ned by the European Telecommunications Standards Institute (ETSI), speci!cally around Management and Orchestration (MANO). It contains its own data model, designed around the ETSI-MANO speci!cation (ETSI GS NFV-SOL 003 V2.4.1), that abstracts away from the ESC core data model.

Related Documents:

IEC 61326-2-6 EN 61326-2-6 JIS C 1806-1 Radio Communications (Excluding Protocol Testing) ETSI EN 300 086 ETSI EN 300 113 ETSI EN 300 220-1 ETSI EN 300 220-2 ETSI EN 300 220-3-1 ETSI EN 300 220-3-2 ETSI EN 300 220-4 ETSI EN

About This Manual 1-2 Print Area Calculation 1-3 PROGRAMMING CONCEPTS Programming Language 2-2 Selecting Protocol Codes 2-3 Using Basic 2-4 Print Position Commands 2-6 COMMAND CODE QUICK REFERENCE A: ESC A Start Label 3-2 ESC A Cut, Label 3-2 ESC a Cut, Job3-2 ESC B Cut, Last 3-2 ESC AO Auto Online 3-2 ESC A1 Media Size 3-2 ESC & Form .

Printer control ESC @ 1B 40 Initialize Graphics commands ESC * 1B 2A Select bit image ESC K 1B 4B 8-dot single-density bit image ESC L 1B 4C 8-dot double-density bit image ESC Y 1B 59 8-dot double-speed double-density bit image ESC Z 1B 5A 8-dot quadruple-density bit image Kanji commands FS Y 1C 59 Specify kanji size

Service manual Electric and Gas Combi 2008/07/28 SEV/KA Model Serial-No. / date from thru Electric: ESC 615 07020594 ESC 620 07020594 ESC 115 07020594 ESC 120 07020594 ESC 215 07020594 ESC 220 07020594 Gas: GSC 615 07020594 GSC 620 07020594 GSC 115 07020594 GSC 120 07020594 GSC 215 07020594 GSC 220 07020594 From software 3.00 1. SmartCombi Service Preposition The documentation may address .

ETSI NFV, which detail REST APIs for management and orchestration, can be accessed by visiting the following links - ETSI GS NFV-SOL 002 and ETSI GS NFV-SOL 003. ETSI GS NFV-SOL 004, has also been completed, it specifies the format and structure of a VNF Package and is based on the OASIS TOSCA Cloud Service Archive (CSAR) format.

NEC Labs Europe GmbH ETSI ISG CIM Chairman (Industry Specification Group Context Information Management) ETSI Board Member ETSI Delegate for: CEN/CENELEC/ETSI SF-SSCC (Sector Forum on Smart and Sustainable Cities and Communities) CEN/CENELEC/ETSI CG-Smart Energy Grid CEN/CENELEC/ET

api 20 e rapid 20e api 20 ne api campy api nh api staph api 20 strep api coryne api listeriaapi 20 c aux api 20 a rapid id 32 a api 50 ch api 50 chb/e 50 chl reagents to be ordered. strips ref microorganisms suspension inoculum transfer medium i

of stuttering [1]. However, consequences of the disorder extend beyond speech. ere is a growing body of evi-dence pointing to decits in cognitive and metalinguis-tic skills in children who stutter [2–5]. CWS have been reported to show weaker executive function (EF; namely, phonological working memory [WM], attentional skills