Table of Contents

VIM

...

VIM registration(Update

...

VIM)

Interface Definition

Description

URI

/api/aai-

vnfm

cloudInfrastructure/v1/

vnfms/vnfm/{vnfmId

cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

Operation Type

PUT

Request ParametersBody:

nametypevendor

Attribute	Qualifier	Cardinality	Content	Description
vnfmIdcloud-owner	OM	0..1	String	VNFM UUID generated by ESR	Cloud owner
cloud-regionId	M	1	String	VNFM name	Cloud region
auth-info	M	1	String	VNFM type
vimId	O	0..1	String	Related VIM
Obj	Auth information of Cloud

authInfo:

Attribute	Qualifier	Cardinality	Content	Description
url	M	1	String	Access url
userName	M	1	StringVNFM	vendorUser name
versionpassword	M	1	String	VNFM versionPassword
descriptiontenant	OM	0..1	StringVNFM	descriptionTenant name
certificateUrldomain	O	0..1	String	certificate urlDomainurl
vendor	M	1	StringAccess	urlVIM vendor
userNameversion	OM	0..1	StringUser	nameVIM version
passwordtype	OM	0..1	StringPassword	VIM type

Request Sample:
/api/aai-vnfmcloudInfrastructure/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee/cloud-regions/cloud-region/owner/region-one

Body:

...

{

...

"cloud-owner":"

...

owner",

...

"cloud-region":"

...

region-one",

...

"authInfo": {

"

...

url":"http://10.74.151.13:5000/v2.0",

"userName":"admin",

"password":"admin",

"tenant":"admin",

"domain":"",

"vendor":"ZTE",

"version":"v1.0",

"type":"openstack"

}

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

Get

...

VIM

Interface Definition

Description

URI

/api/aai-

vnfm

cloudInfrastructure/v1

/vnfms/vnfm/{vnfmId

/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

Operation Type

GET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmIdcloudOwner	M	1	String	VNFM identifier

Request Sample:
/onapapi/aai/esr/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response Parameters:
VNFM

Response Sample:

Success Code: 201

...

Cloud owner
cloudRegionId	M	1	String	Cloud region

Request Sample:
/api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/owner/region-one

Response Parameters:

VIM

Get all VIM

Interface Definition	Description
URI	/api/aai-cloudInfrastructure/v1/cloud-regions
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/onapapi/aai/esr/v1/vims

Response Parameters:
List<VIM>

Response Sample:

Success Code: 201

 [
      "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
 {

       "namecloud-owner":"vnfmowner",

        "typecloud-region":"Tackerregion-one",

        "vimIdauthInfo":"", {

       "vendorurl":"ZTE",
http://10.74.151.13:5000/v2.0",
       "versionuserName":"v1.0admin",
       "descriptionpassword":"vnfmadmin",
       "certificateUrltenant":"admin",
       "urldomain":"http://10.74.44.11",
       "userNamevendor":"adminZTE",
       "passwordversion":"adminv1.0",
   }

Get all VNFM

...

    "type":"openstack"

       }
   ]

Delete VIM

Interface Definition	Description
URI	/apionapapi/aai-vnfm/esr/v1/vnfmsvims?cloudOwner=xxx&cloudRegionId=xxx
Operation Type	GETDELETE

Request Parameters:
N/A

Attribute	Qualifier	Cardinality	Content	Description
vimId	M	1	String	VIM identifier

Request Sample:
/onapapi/aai/esr/v1/vnfms

Response Parameters:
List<VNFM>

Response Samplevims?cloudOwner=owner&cloudRegionId=region-one

Response:

Success

...

Code: 204

Errorcode: 500 Internal Server Error

VNFM

VNFM registration (Update VNFM)

Interface Definition	Description
URI	/api/aai-vnfm/v1/vnfms/vnfm/{vnfmId}
Operation Type	PUT

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	O	0..1	String	VNFM UUID generated by ESR
name	M	1	String	VNFM name
type	M	1	String	VNFM type
vimId	O	0..1	String	Related VIM
vendor	M	1	String	VNFM vendor
version	M	1	String	VNFM version
description	O	0..1	String	VNFM description
certificateUrl	O	0..1	String	certificate url
url	M	1	String	Access url
userName	O	0..1	String	User name
password	O	0..1	String	Password

Request Sample:
/api/aai-vnfm/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Body:

       "urlvnfmId":"http://10.74.44.11",19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

       "name":"vnfm",
       "type":"Tacker",
       "userNamevimId":"admin",
       "vendor":"ZTE",
       "passwordversion":"admin"v1.0",
       "description":"vnfm",
  }    ]

Delete VNFM

...

Request Parameters:

...

 "url":"http://10.74.44.11",
       "certificateUrl":"",
       "userName":"admin",
       "password":"admin"
   }

Response:

Success Code: 204201

Errorcode: 500 Internal Server Error

VIM

...

Get VNFM

Interface Definition	Description
URI	/api/aai-

cloudInfrastructure

vnfm/v1/

cloud-regions/cloud-region

vnfms/vnfm/{

cloud-owner}/{cloud-region-id}

vnfmId}

Operation Type

PUT

GET

Request BodyParameters:

Attribute	Qualifier	Cardinality	Content	Description

cloud-owner

vnfmId

M

1

String

Cloud ownercloud-regionIdM1StringCloud regionauth-infoM1ObjAuth information of Cloud

authInfo:

...

Request Sample:
/api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/owner/region-one

Body:

{

"cloud-owner":"owner",

"cloud-region":"region-one",

"authInfo": {

"url":"http://10.74.151.13:5000/v2.0",

"userName":"admin",

"password":"admin",

"tenant":"admin",

"domain":"",

"vendor":"ZTE",

"version":"v1.0",

"type":"openstack"

}

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

Get VIM

...

/api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

...

Request Parameters:

...

Request Sample:
/api/aai-cloudInfrastructure/v1/cloud-regions/cloud-region/owner/region-one

Response Parameters:

VIM

...

VNFM identifier

Request Sample:
/onapapi/aai/esr/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response Parameters:
VNFM

Response Sample:

Success Code: 201

   {
       "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"vnfm",
       "type":"Tacker",
       "vimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"vnfm",
       "certificateUrl":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
   }

Get all VNFM

Interface Definition	Description
URI	/api/aai-

cloudInfrastructure

vnfm/v1/

cloud-regions

vnfms
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/onapapi/aai/esr/v1/vimsvnfms

Response Parameters:
List<VIM VNFM>

Response Sample:

Success Code: 201

 [
       {
           "cloud-ownervnfmId":"owner19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
           "cloud-regionname":"region-onevnfm",  
           "type":"Tacker",
    "authInfo": {       "urlvimId":"http://10.74.151.13:5000/v2.0",
           "userNamevendor":"adminZTE",
           "passwordversion":"adminv1.0",
           "tenantdescription":"adminvnfm",
           "domaincertificateUrl":"",
           "vendorurl":"ZTE",http://10.74.44.11",
           "versionuserName":"v1.0admin",
           "typepassword":"openstackadmin"
      }       }
   ]

Delete

...

VNFM

Interface Definition	Description
URI	/

onapapi

api/aai-vnfm/v1/

esr

vnfms/

v1/vims?cloudOwner=xxx&cloudRegionId=xxx

vnfm/{vnfmId}
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description

vimId

vnfmId

M

1

String

VIM

VNFM identifier

Request Sample:
/onapapiapi/aai-vnfm/esrv1/vnfms/v1/vims?cloudOwner=owner&cloudRegionId=region-onevnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration (Update SDN Controller)

...

Versions Compared

Old Version 20

New Version 21

Key

VIM

VIM registration(Update

VIM)

Get

VIM

Get all VIM

Get all VNFM

Delete VIM

VNFM

VNFM registration (Update VNFM)

Delete VNFM

VIM

Get VNFM

Get VIM

Get all VNFM

Delete

VNFM

SDN Controller

SDN Controller registration (Update SDN Controller)

Page Comparison

Versions Compared

Old Version 20

New Version 21

Key

VIM

VIM registration(Update

VIM)

Get

VIM

Get all VIM

Get all VNFM

Delete VIM

VNFM

VNFM registration (Update VNFM)

Delete VNFM

VIM

Get VNFM

Get VIM

Get all VNFM

Delete

VNFM

SDN Controller

SDN Controller registration (Update SDN Controller)