Table of Contents

VNFM

VNFM registration

...

Request Parameters:

...

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

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

       "name":"vnfm",
       "type":"Tacker",
       "vimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"vnfm",
       "url":"http://10.74.44.11",
       "certificateUrl":"",
       "userName":"admin",
       "password":"admin"
   }

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

...

Table of Contents

VIM

VIM registration

Interface Definition	Description
URI	/api/aai-esr-server/v1/vims
Operation Type	POST

Request Body:

Attribute	Qualifier	Default	Content	Description
cloudOwner	M		String	cloud owner name, can be customized, e.g. att-aic
cloudRegionId	M		String	cloud region info based on deployment, e.g. RegionOne
cloudType	M		String	type of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersion	M		String	cloud version, ocata, mitaka or other
ownerDefinedType	O		String	Cloud-owner defined type indicator (e.g., dcp, lcp)
cloudZone	O		String	Zone where the cloud is homed.
complexName	O		String	complex name for cloud-region instance.
cloudExtraInfo	O		String	extra info for Cloud
vimAuthInfos	M	1	[Obj]	Auth information of Cloud

authInfoItem:

Attribute	Qualifier	Content	Description
cloudDomain	M	String	domain info for keystone v3
userName	M	String	User name
password	M	String	Password
authUrl	M	String	authentication url of the cloud, e.g. keystone url
sslCacert	O	String	ca file content if enabled ssl on auth-url
sslInsecure	O	Boolean	Whether to verify VIM's certificate

Request Sample:
/api/aai-esr-server/v1/vims

Body:

{
 "cloudOwner": "ZTE",
 "cloudRegionId": "region-one",
 "cloudType": "openstack",
 "cloudRegionVersion": "v1.0",
 "ownerDefinedType": "owner-defined-type",
 "cloudZone": "cloud zone",
 "complexName": "complex name",
 "cloudExtraInfo": "cloud-extra-info",
 "vimAuthInfos": 
 [{
 "userName": "admin",
 "password": "admin",
 "authUrl": "http://10.74.151.13:5000/v2.0",
 "sslCacert": "ssl-cacert",
 "sslInsecure": true,
 "cloudDomain": "cloud-domain"
 }]
}

Response:

Success Code: 200

body:

{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one"
}

Errorcode: 500 Internal Server Error

Update VIM info

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/vims/vnfms{cloudOwner}/{vnfmIdcloudRegionId}
Operation Type	GETPUT

Request ParametersBody:

vnfmId

Attribute	Qualifier	CardinalityDefault	Content	Description
cloudType	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

   {
       "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

...

Request Parameters:
N/A

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

Response Parameters:
List<VNFM>

Response Sample:

Success Code: 201

...

	String	type of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersion	M		String	cloud version, ocata, mitaka or other
ownerDefinedType	O		String	Cloud-owner defined type indicator (e.g., dcp, lcp)
cloudZone	O		String	Zone where the cloud is homed.
complexName	O		String	complex name for cloud-region instance.
cloudExtraInfo	O		String	extra info for Cloud
vimAuthInfos	M		[Obj]	Auth information of Cloud

authInfoItem:

Attribute	Qualifier	Content	Description
cloudDomain	M	String	domain info for keystone v3
userName	M	String	User name
password	M	String	Password
authUrl	M	String	authentication url of the cloud, e.g. keystone url
sslCacert	O	String	ca file content if enabled ssl on auth-url
sslInsecure	O	Boolean	Whether to verify VIM's certificate

Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one

{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one",
"cloudType": "openstack",
"cloudRegionVersion": "v1.0",
"ownerDefinedType": "owner-defined-type",
"cloudZone": "cloud zone",
"complexName": "complex name",
"cloudExtraInfo": "cloud-extra-info",
"vimAuthInfos":
[{
"userName": "admin",
"password": "admin",
"authUrl": "http://10.74

...

.151.13:5000/v2.0",
"sslCacert": "ssl-cacert",
"sslInsecure": true,
"cloudDomain": "cloud-domain"
}]
}

Get VIM

Interface Definition

Description

URI

/

onapapi

api/aai

/

-esr-server/v1/vims/

vnfms

{cloudOwner}/{

vnfmId

cloudRegionId}

Operation Type

PUTGET

Request Parameters:

O0..

Attribute	Qualifier	Cardinality	Content	Description
vnfmIdcloudOwner	M	1	StringVNFM	identifierCloud ownername
cloudRegionId	M	1	String	VNFM name
vendor	O	0..1	String	VNFM vendor
url	O	0..1	String	Access url
userName	O	0..1	String	User name
password	O	0..1	String	Password

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

   {
       "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"vnfm",
       "vendor":"ZTE",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin"
   }

Response Parameters:

...

Cloud region

Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one

Response Parameters:

VIM

Get all VIM

Interface Definition	Description
URI	/api/aai-esr-server/v1/vims
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/vims

Response Parameters:
List<VIM>

Delete VIM

Interface Definition	Description
URI	/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vimId	M	1	String	VIM identifier

Request Sample:
/api/aai-esr-server/v1/vims/owner/region-one

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

VNFM

...

VNFM registration

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/vnfms/{vnfmId}
Operation Type	DELETEPOST

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmIdname	M	1	String	VNFM identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

VIM

VIM registration

...

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

...

Request Body:

AttributeQualifierCardinalityContentDescriptioncloudOwnerCloud ownercloudRegionIdM

Attribute	Qualifier	Cardinality	Content	Description
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
certificateUrl	O	0..1	String	Cloud region
authInfo	M	1	Obj	Auth information of Cloud

authInfo:

certificate url
url	M	1	String	Access url
userName

M

O	0..1	String	User name
password

M1StringPasswordtenantM1StringTenant namedomain

O

0..1

String

Domain

Password

vendorM1StringVIM vendorversionM1StringVIM versiontypeM1StringVIM type

Request Sample:
/onapapi/aai/esr/v1/vimsRequest Sample:
/api/aai-esr-server/v1/vnfms

Body:

       "cloud-ownername":"ownervnfm",

       "cloud-regiontype":"region-oneTacker",
       "authInfovimId":"",
{       "urlvendor":"http://10.74.151.13:5000/v2.0ZTE",
       "userNameversion":"adminv1.0",
       "passwordurl":"adminhttp://10.74.44.11",
       "tenantcertificateUrl":"admin",
       "domainuserName":"admin",
       "vendorpassword":"ZTEadmin",
       "version":"v1.0",}

Response:

        "typevnfmId":"openstack"

       }
   }

...

19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

}

Success Code: 201200

Errorcode: 500 Internal Server Error

...

VNFM update

Interface Definition	Description
URI	/api/aai-esr-cloudInfrastructureserver/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}vnfms/{vnfmId}
Operation Type	GETPUT

Request Parameters:

cloudRegionId

Attribute	Qualifier	Cardinality	Content	Description
cloudOwnername	M	1	StringCloud	ownerVNFM name
type	M	1	String	VNFM type	Cloud region

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

Response Parameters:

Get all VIM

...

vimId	O	0..1	String	Related VIM
vendor	M	1	String	VNFM vendor
version	M	1	String	VNFM version
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:
/onapapiapi/aai/-esr-server/v1/vims

Response Parameters:
List<VIM>

Response Sample:

Success Code: 201

...

/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Body:

       "name":"vnfm",

    {   "type":"Tacker",
       "cloud-ownervimId":"owner",
       "vendor":"ZTE",
       "cloud-regionversion":"region-onev1.0",  
        "url":"http://10.74.151.13:5000/v2.0",
   44.11",
       "userNamecertificateUrl":"admin",
  
        "passworduserName":"admin",
  
        "tenantpassword":"admin",
           "vendor":"ZTE",
           "version":"v1.0",
           "domain":"",
           "type":"openstack"
       }
   ]

...

Response:

Success Code: 200

Errorcode: 500 Internal Server Error

Get VNFM

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/vims?cloudOwner=xxx&cloudRegionId=xxx/vnfms/{vnfmId}
Operation Type	PUTGET

Request Parameters:

cloudOwner

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	Cloud owner
cloudRegionId	M	1	String	Cloud region
url	O	0..1	String	Access url
userName	O	0..1	String	User name
password	O	0..1	String	Password
tenant	O	0..1	String	Tenant name
domain	O	0..1	String	Domain
vendor	O	0..1	String	VIM vendor

Request Sample:
/onapapi/aai/esr/v1/vims?cloudOwner=owner&cloudRegionId=region-one

VNFM identifier

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

Response Parameters:
VNFM

Response Sample:

Success Code: 200

   {
       "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"vnfm",
       "cloudOwnertype":"ownerTacker",
       "cloudRegionIdvimId":"region-one",
       "urlvendor":"http://10.74.151.13:5000/v2.0ZTE",
       "userNameversion":"adminv1.0",
       "passwordcertificateUrl":"admin",
       "tenanturl":"adminhttp://10.74.44.11",
       "domainuserName":"admin",
       "versionpassword":"v2.0admin",
   }

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

Delete VIM

...

Get all VNFM

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/vims?cloudOwner=xxx&cloudRegionId=xxxvnfms
Operation Type	DELETEGET

Request Parameters:

...

N/A

Request Sample:
/onapapiapi/aai/-esr-server/v1/vims?cloudOwner=owner&cloudRegionId=region-oneResponsevnfms

Response Parameters:
List<VNFM>

Response Sample:

Success Code:

...

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration

...

Request Parameters:

...

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

   { 200

 [
       {
           "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
           "name":"vnfm",
           "type":"Tacker",
           "vimId":"",
           "vendor":"ZTE",
           "version":"v1.0",
           "certificateUrl":"",
           "url":"http://10.74.44.11",
           "nameuserName":"sdnadmin",
           "urlpassword":"http://10.74.151.13:8181","admin"
       "userName":"admin",}
       "password":"admin",
       "version":"v1.0",
       "vendor":"ZTE",
       "description":"",
       "protocol":"netconf",
       "productName":"",
       "type":"WAN"
   }

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

Get SDN Controller by id

...

Delete VNFM

Interface Definition	Description
URI	/api/aai-esr-server/v1/vnfms/{vnfmId}
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration

Interface Definition	Description
URI	/api/aai-esr-server/v1/sdncontrollers
Operation Type	POST

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	UUID of sdncontroller
name	M	1	String	SDN Controller identifiername

Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5

Response Parameters:
SDN Controller

Response Sample:

Success Code: 201

...

location	O	1	String	fit for DC type
url	M	1	String	Access url
vendor	M	1	String	SDNC vendor
version	M	1	String	SDNC version
description	O	0..1	String	SDNC description
productName	O	0..1	String	SDNC productName
protocol	M	1	String	protocol, such as netconf/snmp
userName	M	1	String	User name
password	M	1	String	Password
type	M	1	Enum{WAN/DC}	SDN Controller type

Request Sample:
/api/aai-esr-server/v1/sdncontrollers

Body:

{

"name":"sdn",

"url":"http://10.74.151.13:8181",

"userName":"admin",

"password":"admin",

"version":"v1.0",

"vendor":"ZTE",

...

"description":"",

...

"protocol":"netconf",

...

"productName":"",

...

"type":"WAN"

...

}

Response:

body:

{

"sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",

}

Success Code: 200

Errorcode: 500 Internal Server Error

Update SDN Controller info

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation Type	GETPUT

Request Parameters:

Attribute

...

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

Response Parameters:
List<SDN Controller>

Response Sample:

Success Code: 201

...

Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	UUID of sdncontroller
name	M	1	String	SDN Controller name
location	O	1	String	fit for DC type
url	M	1	String	Access url
vendor	M	1	String	SDNC vendor
version	M	1	String	SDNC version
description	O	0..1	String	SDNC description
productName	O	0..1	String	SDNC productName
protocol	M	1	String	protocol, such as netconf/snmp
userName	M	1	String	User name
password	M	1	String	Password
type	M	1	Enum{WAN/DC}	SDN Controller type

Request Sample:
/api/aai-esr-server/v1/sdncontrollers/a6c42529-cd6b-4c01-b149-03eb54b20a03

Body:

{

"name":"sdn",

"url":"http://10.74.151.13:8181",

"userName":"admin",

"password":"admin",

...

"version":"v1.0",

...

"vendor":"ZTE",

...

"description":"",

...

"protocol":"netconf",

...

"productName":"",

"type":"WAN"

...

}

Response:

Success Code: 200

Errorcode: 500 Internal Server Error

Get SDN Controller

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation Type	PUTGET

Request Parameters:

String

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	SDN Controller identifier	name	O	0..1

Request Sample:
/api/aai-esr-server/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5

Response Parameters:
SDN Controller

...

Request Sample:
/onapapi/aai/esr/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5

...

Response Sample:

Success Code: 200

   {
       "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
       "name":"sdn",
       "url":"http://10.74.151.13:8181",
       "userName":"admin",
       "password":"admin", 
       "nameversion":"sdn",
       "url":"http://10.74.151.13:8181v1.0",
       "userNamevendor":"adminZTE",
       "passworddescription":"admin",
       "versionprotocol":"v1.0netconf",
       "vendorproductName":"ZTE",
       "descriptiontype":"",
       "protocol":"netconf",
       "productName":"WAN"
   }

...

Get all SDN Controller

...

Response Sample:

Success Code: 201

...

Interface Definition	Description
URI	/api/aai-esr-server/v1/sdncontrollers
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/sdncontrollers

Response Parameters:
List<SDN Controller>

Response Sample:

Success Code: 200

 [
       {
           "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
           "name":"sdn",
           "url":"http://10.74.151.13:8181",
           "userName":"admin",
           "password":"admin",
           "version":"v1.0",
       "    "vendor":"ZTE",
           "description":"",
           "protocol":"netconf",
           "productName":"", 
           "type":"WAN",
       "createTime":"2016-07-18 12:22:53"}
   }]

Delete SDN Controller

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation Type	DELETE

...

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	SDN Controller identifier

Request Sample:
/onapapiapi/aai/-esr-server/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5

...

Errorcode: 500 Internal Server Error

EMS

...

registration

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/emses
Operation Type	PUTPOST

Request Parameters:

UUID generated by esr-server

Attribute	Qualifier	Cardinality	Content	Description	emsId	M	1	String
name	M	1	String	EMS name
vendor	M	1	String	vendor
version	M	1	String	version
description	O	0..1	String	description
resourceAddr	M	1	Obj	Address to get resource data
performanceAddr	M	1	Obj	Address to get performance data
alarmAddr	M	1	Obj	Address to get alarm data

...

Attribute	Qualifier	Cardinality	Content	Description
ip	M	1	String	service IP of ftp server
port	M	1	String	service port of ftp server
user	M	1	String	ftp user name
password	M	1	String	ftp password

Request Sample:

/onapapiapi/aai/-esr-server/v1/emses

Body:

{

"emsName": "EMS_TEST",

...

"version":"v1.0",

...

"vendor":"ZTE",

...

"description":"",

...

"resouceAddr": {

"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true

...

},

...

"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true

...

},

...

"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"

...

}

Response ParametersSample:EMS

Response Samplebody:

{

"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

...

"emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE",
  "description":"",

  "createTime":"2016-07-18 12:22:53"

"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}

Get EMS by id

...

}

Success Code: 200

Errorcode: 500 Internal Server Error

Update EMS info

Interface Definition	Description
URI	/api/aai-esr-server/v1/emses/{emsId}
Operation Type	PUT

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
name	M	1	String	EMS name
vendor	M	1	String	vendor
version	M	1	String	version
description	O	0..1	String	description
resourceAddr	M	1	Obj	Address to get resource data
performanceAddr	M	1	Obj	Address to get performance data
alarmAddr	M	1	Obj	Address to get alarm data

resourceAddr:

emsId

Attribute	Qualifier	Cardinality	Content	Description
ftptype	M	1	Enum{ftp/sftp}	ftp type
ip	M	1	String	EMS identifier

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

Response Parameters:
EMS

Response Sample:

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

"emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE",
  "description":"",

  "createTime":"2016-07-18 12:22:53"

"resouceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},
"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true
},
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}

Get all EMS

...

Request Parameters:
N/A

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

Response Parameters:
List<EMS>

Response Sample:

Success Code: 201

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

"emsName": "EMS_TEST",

...

	service IP of ftp server
port	M	1	String	service port of ftp server
user	M	1	String	ftp user name
password	M	1	String	ftp password
remotepath	M	1	String	resource data file path
passive	M	1	Boolean	ftp passive mode or not

performanceAddr:

Attribute	Qualifier	Cardinality	Content	Description
ftptype	M	1	Enum{ftp/sftp}	ftp type
ip	M	1	String	service IP of ftp server
port	M	1	String	service port of ftp server
user	M	1	String	ftp user name
password	M	1	String	ftp password
remotepath	M	1	String	performance data file path
passive	M	1	Boolean	ftp passive mode or not

alarmAddr:

Attribute	Qualifier	Cardinality	Content	Description
ip	M	1	String	service IP of ftp server
port	M	1	String	service port of ftp server
user	M	1	String	ftp user name
password	M	1	String	ftp password

Request Sample:

/api/aai-esr-server/v1/emses

Body:

{

"emsName": "EMS_TEST",

"version":"v1.0",

"vendor":"ZTE",

...

"description":"",

  "createTime":"2016-07-18 12:22:53"

...

"resouceAddr": {

"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true

...

},

...

"

...

performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true

...

},

...

"

...

alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"

...

}

...

Get EMS by id

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/emses/{emsId}
Operation Type	PUTGET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier
name	O	0..1	String	EMS name
vendor	O	0..1	String	Vendor
version	O	0..1	String	version
description	O	0..1	String	description
resourceAddr	O	0..1	Obj	Address to get resource data
performanceAddr	O	0..1	Obj	Address to get performance data
alarmAddr	O	0..1	Obj	Address to get alarm data

resourceAddr:

...

performanceAddr:

...

alarmAddrRequest Sample:
/api/aai-esr-server/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response Parameters:
EMS

Response Sample:

{

"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

"emsName": "EMS_TEST",

"version":"v1.0",

"vendor":"ZTE",

"description":"",

"resouceAddr": {

"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},

"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true

},

"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"

}

Get all EMS

Interface Definition	Description
URI	/api/aai-esr-server/v1/emses
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/emses

Response Parameters:
List<EMS>

Response Sample:

Success Code: 200

[

{

"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

"emsName": "EMS_TEST",

"version":"v1.0",

"vendor":"ZTE",

"description":"",

"resouceAddr": {

"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/res/data/",
"passive": true
},

"performanceAddr": {
"ftptype": "ftp",
"ip": "10.44.55.145",
"port": "2000",
"user": "root",
"password": "test",
"remotepath": "/opt/Gcp/data/",
"passive": true

},

"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"

}

]

Delete EMS

Interface Definition	Description
URI	/api/aai-esr-server/v1/emses/{emsId}
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier

Request Sample:
/api/aai-esr-server/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

PNF

PNF registration

Interface Definition	Description
URI	/api/aai-esr-server/v1/pnfs
Operation Type	POST

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
pnfId	M	1	String	unique ID of PNF
userLabel	M	1	String	PNF system name
subnetId	M	1	String	subnet ID of DU network element
neId	M	1	String	network element ID
managementType	O	1	String
vendor	O	1	String
pnfdId	M	1	String
emsId	M	1	String
lattitude	O	1	String
longitude	O	1	String

Request Sample:
/api/aai-esr-server/v1/pnfs

Body:

       "pnfId":"dafdaf3213dfa",

       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }

Response:

Success Code: 200

Errorcode: 500 Internal Server Error

Update PNF info

Interface Definition	Description
URI	/api/aai-esr-server/v1/pnfs/{pnfId}
Operation Type	PUT

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description

ip

pnfId

O

M

0..0..

1

String

service IP of ftp serverportO0..

unique ID of PNF
userLabel	M	1	String	PNF system name
subnetId	M	1	String

service port of ftp serveruserO

subnet ID of DU network element
neId	M	1	String

ftp user namepassword

network element ID
managementType	O

0..

1

String

ftp password

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

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

"emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE",
  "description":"",

  "createTime":"2016-07-18 12:22:53"

...


vendor	O	1	String
pnfdId	M	1	String
emsId	M	1	String
lattitude	O	1	String
longitude	O	1	String

Body:Request Sample:
/api/aai-esr-server/v1/pnfs/dafdaf3213dfa

       "pnfId":"dafdaf3213dfa",

       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }

Response:

Success Code: 201200

Errorcode: 500 Internal Server Error

...

Get PNF by ID

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/emsespnfs/{emsIdpnfId}
Operation Type	DELETEGET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
emsIdpnfId	M	1	String	EMS PNF identifier

Request Sample:
/onapapiapi/aai/-esr-server/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

Other

Get basic info by id

Interface Definition	Description
URI	/onapapi/aai/esr/v1/common/{instanceId}
Operation Type	GET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
instanceId	M	1	String	External system identifier

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

Response Parameters:

...

Response Sample:

...

/pnfs/dafdaf3213dfa

Response Parameters:
PNF

Response Sample:

Success Code: 200

       "pnfId":"dafdaf3213dfa",

       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }

Get all PNF

Interface Definition	Description
URI	/api/aai-esr-server/v1/pnfs
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/pnfs

Response Parameters:
List<PNF>

Response Sample:

Success Code: 200

       "pnfId":"dafdaf3213dfa",

       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "instanceIdneId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee4f6asd8ff4asd",
       "categorymanagementType":"VNFMtest",
       "namevendor":"vnfmzte",
       "descriptionpnfdId":"8f7adfa8fa9",
       "versionemsId":"v1.0fdsa5f4afd4a",
       "vendorlattitude":"ZTE156.446",
       "typelongitude":"Tacker121.154",
       "createTime":"2016-07-18 12:22:53"
   }
}

Delete PNF

Interface Definition	Description
URI	/api/aai-esr-server/v1/pnfs/{pnfId}
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
pnfId	M	1	String	PNF identifier

Request Sample:
/api/aai-esr-server/v1/pnfs/dafdaf3213dfa

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

Information elements

VNFM

identifier(UUID)description

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	O	0..1	String	VNFM
name	String	VNFM name
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 descriptionvendor
version	M	1	String	VNFM version
vendorcertificateUrl	String	VNFM vendor	typeO	0..1	StringVNFM	typecertificate url
url	M	1	String	Access url
userName	O	0..1	String	User name
password	String	Password	createTimeO	0..1	String	Create time
vimId	String	Related VIM
certificateUrl	String	VNFM certificate urlPassword

VIM

Attribute	Qualifier

Cardinality

Default	Content

DescriptioncloudOwnerM1StringCloud ownercloudRegionIdM1StringCloud regioncloud-typeO0...1StringType of the cloud (e.g., openstack)owner-defined-typeO0...1StringCloud-owner defined type indicatorcloud-region-versionO0...1StringSoftware version employed at the siteidentity-urlO0...1StringURL of the keystone identity servicecloud-zoneO0...1

	Description
cloudOwner	M	String	cloud owner name, can be customized, e.g. att-aic
cloudRegionId	M	String	cloud region info based on deployment, e.g. RegionOne
cloudType	M	String	type of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersion	M	String	cloud version, ocata, mitaka or other
ownerDefinedType	O	String	Cloud-owner defined type indicator (e.g., dcp, lcp)
cloudZone	O	String	Zone where the cloud is homed.

complex-name

complexName

O

String

0...1

complex name for cloud-region instance.
cloudExtraInfo	O		String

complex name for cloud-region instanceresource-versionO0...1StringUsed for optimistic concurrency. Must be empty on create, valid on update and delete.volume-groupsO0...1object[]tenantsO0...1object[]flavorsO0...1object[]group-assignmentsO0...1object[]snapshotsO0...1object[]imagesO0...1object[]availability-zonesO0...1object[]relationship-listO0...1object[]authInfoM1ObjAuth information of Cloud

volume-group

...

extra info for Cloud
vimAuthInfos	M	1	[Obj]	Auth information of Cloud

vimAuthInfo:

Attribute	Qualifier	Content	Description
cloudDomain	M	String	domain info for keystone v3
userName	M	String	User name
password	M	String	Password
authUrl	M	String	authentication url of the cloud, e.g. keystone url
defaultTenant	O	String
sslCacert	O	String	ca file content if enabled ssl on auth-url
sslInsecure	O	Boolean	Whether to verify VIM's certificate

SDN Controller

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	UUID of sdncontroller
name	M	1	String	SDN Controller name
location	O	1	String	fit for DC type
url	M	1	String	Access url
vendor	M	1	String	SDNC vendor
version	M	1	String	SDNC version
description	O	0..1	String	SDNC description
productName	O	0..1	String	SDNC productName
protocol	M	1	Enum{netconf/snmp}	protocol
userName	M	1	String	User name
password	M	1	String	Password
type	M	1	Enum{WAN/DC}	SDN Controller type

EMS

...

resourceAddr:

Attribute	Qualifier	Cardinality	Content	Description

url

emsId

M

1

String

Access url

EMS identifier

userName

name

M

O

0..1

String

User

EMS name

password

vendor

M

O

0..1

String

Password

Vendor

tenant

version

M

O

0..1

String

Tenant name

version

domain

description

O

0..1

String

Domain

description

vendor

resourceAddr

M

O

0..1

StringVIM vendorversionM1StringVIM versiontypeM1StringVIM type

...

ip

Attribute	Content	Description
ftptype	Enum{ftp/sftp}	ftp type
Obj	Address to get resource data
performanceAddr	O	0..1	Obj	Address to get performance data
alarmAddr	O	0..1	Obj	Address to get alarm data

resourceAddr

Attribute	Qualifier	Cardinality	Content	Description
ftptype	O	0..1	Enum{ftp/sftp}	ftp type
ip	O	0..1	String	service IP of ftp server
port	O	0..1	String	service port of ftp server
user	O	0..1	String	ftp user name
password	O	0..1	String	ftp password
remotepath	O	0..1	String	resource data file path
passive	O	0..1	Boolean	ftp passive mode or not

performanceAddr

Attribute	Qualifier	Cardinality	Content	Description
ftptype	O	0..1	Enum{ftp/sftp}	ftp type
ip	O	0..1	String	service IP of ftp server
port	O	0..1	String	service port of ftp server
user	O	0..1	String	ftp user name
password	O	0..1	String	ftp password
remotepath	O	0..1	String	performance data file path
passive	O	0..1	Boolean	ftp passive mode or not

alarmAddr

Attribute	Qualifier	Cardinality	Content	Description
ip	O	0..1	String	service IP of ftp server
port	O	0..1	String	service port of ftp server
user	O	0..1	String	ftp user name
password	O	0..1	String	ftp password

PNF

Attribute

remotepath

Qualifier

Stringresource data file pathpassiveBooleanftp passive mode or not

performanceAddr:

...

alarmAddr:

AttributeContentDescriptionipStringservice IP of ftp serverportStringservice port of ftp serveruserStringftp user namepasswordStringftp password

Cardinality	Content	Description
pnfId	M	1	String	unique ID of PNF
userLabel	M	1	String	PNF system name
subnetId	M	1	String	subnet ID of DU network element
neId	M	1	String	network element ID
managementType	O	1	String
vendor	O	1	String
pnfdId	M	1	String
emsId	M	1	String
lattitude	O	1	String
longitude	O	1	String

Page Comparison

Versions Compared

Old Version 14

New Version Current

Key

VNFM

VNFM registration

VIM

VIM registration

Update VIM info

Get all VNFM

Get VIM

Get all VIM

Delete VIM

VNFM

VNFM registration

VIM

VIM registration

VNFM update

Get all VIM

Get VNFM

Delete VIM

Get all VNFM

SDN Controller

SDN Controller registration

Get SDN Controller by id

Delete VNFM

SDN Controller

SDN Controller registration

Update SDN Controller info

Get SDN Controller

Get all SDN Controller

Delete SDN Controller

EMS

EMS

registration

Get EMS by id

Update EMS info

Get all EMS

Get EMS by id

Get all EMS

Delete EMS

PNF

PNF registration

Update PNF info

Get PNF by ID

Other

Get basic info by id

Get all PNF

Delete PNF

Information elements

VNFM

VIM

volume-group

SDN Controller

EMS

EMS

resourceAddr

performanceAddr

alarmAddr

PNF