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	/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}
Operation Type	PUT

Request Body:

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

VNFM

VNFM registration

...

Request Parameters:

...

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

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

Response Parameters:
VNFM

Response Sample:

   {
       "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",
       "createTime":"2016-07-06 15:33:18"
   }

Get VNFM by id

Interface Definition	Description
URI	/onapapi/aai/esr/v1/vnfms/{vnfmId}
Operation Type	GET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier

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

Response Parameters:
VNFM

Response Sample:

...

": "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
/vnfms
/vims/{cloudOwner}/{cloudRegionId}
Operation Type GET
Request Parameters:
Attribute
...
Qualifier Cardinality Content Description
cloudOwner M 1 String Cloud owner
cloudRegionId M 1 String 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	/api/aai-esr-server/v1/vnfms
Operation Type	POST

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

Response Parameters:
List<VNFM>

Response Sample:

   [
       {
           "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",
           "createTime":"2016-07-06 15:33:18"
       }
   ]

Update VNFM

Interface Definition	Description
URI	/onapapi/aai/esr/v1/vnfms/{vnfmId}
Operation Type	PUT

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmIdname	M	1	String	VNFM identifiernamename
type	OM	0..1	String	VNFM nametype
vendorvimId	O	0..1	String	Related VIM
VNFM vendor	url	O	M	0..1	StringAccess	urlVNFM vendor
userNameversion	OM	0..1	StringUser	nameVNFM version
passwordcertificateUrl	O	0..1	String	Password	certificate url
url	M	1	String	Access url
userName	O	0..1	String	User name
password	O	0..1	String	Password

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

Body:


       "vnfmIdname":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29eevnfm",


       "nametype":"vnfmTacker",
       "vendorvimId":"ZTE",
       "urlvendor":"http://10.74.44.11ZTE",
       "userNameversion":"adminv1.0",
       "passwordurl":"admin"http://10.74.44.11",
   }

Response Parameters:
VNFM

Response Sample:

   {
       "vnfmId"certificateUrl":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "nameuserName":"vnfmadmin",
       "typepassword":"Tackeradmin",
       "vimId":"",
}

Response:

       "vendorvnfmId":"ZTE",
       "version":"v1.0",
       "description":"vnfm",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
       "createTime":"2016-07-06 15:33:18"
   }

Delete VNFM

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

}

Success Code: 200

Errorcode: 500 Internal Server Error

VNFM update

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmIdname	M	1	String	VNFM identifiername

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

Response Parameters:
N/A

Response Sample:
N/A

VIM

VIM registration

Interface Definition	Description
URI	/onapapi/aai/esr/v1/vims
Operation Type	POST

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
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	certificate url
name	M	1	String	VIM name
url	M	1	String	Access url
userName	M	1	String	User name	password	M	1	String	Password
tenant	M	1	String	Tenant name
domain	O	0..1	String	Domain
vendor	M	1	String	VIM vendor
version	M	1	String	VIM version
User name
passworddescription	O	0..1	String	VIM description
type	M	1	Enum{openstack/vmware}	VIM type
Password

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

Body:


       "name":"vimvnfm",


       "urltype":"http://10.74.151.13:5000/v2.0Tacker",
       "userNamevimId":"admin",
       "passwordvendor":"adminZTE",
       "tenantversion":"adminv1.0",
       "domainurl":"",
       "vendor":"ZTEhttp://10.74.44.11",
       "versioncertificateUrl":"v1.0",
       "descriptionuserName":"admin",
       "typepassword":"openstackadmin"
   }

Response Parameters:VIM

Response Sample:

Success Code: 200

Errorcode: 500 Internal Server Error

Get VNFM

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

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 Parameters:
VNFM

Response Sample:

Success Code: 200

   {   {
       "vimId":"57674786-5b2e-4c92-bb68-578dbd79e2f5",
       "name":"vim",
       "url":"http://10.74.151.13:5000/v2.0",
       "userNamevnfmId":"admin",
19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"vnfm",
       "passwordtype":"adminTacker",
       "tenantvimId":"admin",
       "vendor":"ZTE",
       "version":"v1.0",
       "descriptioncertificateUrl":"",
       "domainurl":"http://10.74.44.11",
       "typeuserName":"openstackadmin",
       "createTimepassword":"2016-07-18 12:22:53"admin",
   }

Get

...

all VNFM

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/vims/{vimId}vnfms
Operation Type	GET

Request Parameters:

...

N/A

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

Response Parameters:
VIMList<VNFM>

Response Sample:

Success Code: 200

 [
       {
           "vimIdvnfmId":"5767478619ecbb3a-5b2e3242-4c924fa3-bb689926-578dbd79e2f58dfb7ddc29ee",
           "name":"vimvnfm",
           "urltype":"http://10.74.151.13:5000/v2.0",
"Tacker",
       "userName":"admin",
       "passwordvimId":"admin",
       "tenant":"admin",
       "vendor":"ZTE",
           "version":"v1.0",
           "descriptioncertificateUrl":"",
           "domainurl":"http://10.74.44.11",
           "typeuserName":"openstackadmin",
           "createTimepassword":"2016-07-18 12:22:53""admin"
       }
   }]

...

Delete VNFM

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

Request Parameters:
N/A

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier

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

Response Parameters:List<VIM>

Response Sample:

   [
       {
           "vimId":"57674786-5b2e-4c92-bb68-578dbd79e2f5",
           "name":"vim",
           "url":"http://10.74.151.13:5000/v2.0",
           "userName":"admin",
           "password":"admin",
           "tenant":"admin",
           "vendor":"ZTE",
           "version":"v1.0",
           "description":"",
           "domain":"",
           "type":"openstack",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

Update VIM

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

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	/api/aai-esr-server/v1/sdncontrollers/{sdnControllerId
Interface Definition	Description
URI	/onapapi/aai/esr/v1/vims/{vimId}
Operation Type	PUT

Request Parameters:

vimIdVIM identifier0..

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	UUID of sdncontroller
name	OM	0..1	String	VIM SDN Controller nameurl
location	O	1	String	fit for DC type
url	M	1	String	Access Access url
userNamevendor	OM	0..1	StringUser	nameSDNC vendor
passwordversion	OM	0..1	StringPassword	SDNC version
tenantdescription	O	0..1	StringTenant	nameSDNC description
domainproductName	O	0..1	StringDomain	SDNC productName
vendorprotocol	OM	0..1	String	VIM vendor

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

...

	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	/api/aai-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation Type	GET

Request Parameters:

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

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

Response Parameters:
SDN Controller

Response Sample:

Success Code: 200

Response Parameters:
VIM

Response Sample:

   {
       "vimId":"57674786-5b2e-4c92-bb68-578dbd79e2f5",
       "name":"vim",
       "url":"http://10.74.151.13:5000/v2.0",
       "userNamesdnControllerId":"admina6c42529-cd6b-4c01-b149-03eb54b20a03",
       "name":"sdn",
       "passwordurl":"adminhttp://10.74.151.13:8181",
       "tenantuserName":"admin",
       "vendorpassword":"ZTEadmin", 
       "version":"v2v1.0",
       "descriptionvendor":"ZTE",
       "domaindescription":"",
       "typeprotocol":"openstacknetconf",
       "createTimeproductName":"2016-07-18 12:22:53"",
       "type":"WAN"
   }

...

Get all SDN Controller

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/vims/{vimId}sdncontrollers
Operation Type	DELETEGET

Request Parameters:

...

N/A

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

Response Parameters:
N/AList<SDN Controller>

Response Sample:N/A

SDN Controller

SDN Controller registration

Interface Definition	Description
URI	/onapapi/aai/esr/v1/sdncontrollers
Operation Type	POST

Request Parameters:

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"
       }
   ]

Delete SDN Controller

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

Request Parameters:

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

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

EMS

EMS registration

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

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:

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	resource data file path
passive	M	1	Boolean	ftp passive mode or not

performanceAddr:

url

AttributeAttribute	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	SDN Controller name		ftp password
remotepath	M	1	String	performance data file path
passive		M	1	String	Access url
vendor	M	1	String	SDNC vendor
	Boolean	ftp passive mode or not

alarmAddr:

version0..0..protocol

Attribute	Qualifier	Cardinality	Content	Description
ip		M	1	String	SDNC version	description	O	service IP of ftp server
port	M	1	String	SDNC description	productName	O	service port of ftp server
user	M	1	String	SDNC productName	ftp user name
password		M	1	Enum{netconf/snmp}	protocol
userName	M	1	String	User name
password	M	1	String	Password
type	M	1	Enum{ODL/ONOS}	SDN Controller type

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

   {
       "name":"sdn",
       "url":"http://10.74.151.13:8181",
       "userName":"admin",
       "password":"admin",
       "version":"v1.0",
       "vendor":"ZTE",
       "description":"",
       "protocol":"netconf",
       "productName":"",
       "type":"ODL"
   }

Response Parameters:
SDN Controller

Response Sample:

   {
       "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":"ODL",
       "createTime":"2016-07-18 12:22:53"
   }

Get SDN Controller by id

Interface Definition	Description
URI	/onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId}
Operation Type	GET

String

ftp password

Request Sample:

/api/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 Sample:

body:

{

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

}

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:

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

alarmAddrRequest Parameters:

sdnControllerId

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	SDN Controller identifier

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

Response Parameters:
SDN Controller

Response Sample:

...

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":"",

...

"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	/api/aai-esr-server/v1/emses/{emsId}
Operation Type	GET

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

Get all SDN Controller

Interface Definition	Description
URI	/onapapi/aai/esr/v1/sdncontrollers
Operation Type	GET

Request Parameters:
N/A

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

Response Parameters:
List<SDN Controller>

Response Sample:

   [
       {
           "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":"ODL",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

Update SDN Controller

Interface Definition	Description
URI	/onapapi/aai/esr/v1/sdncontrollers/{sdnControllerId}
Operation Type	PUT

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	SDN Controller identifier
name	O	0..1	String	SDN Controller name
url	O	0..1	String	Access url
vendor	O	0..1	String	SDNC vendor
version	O	0..1	String	SDNC version
description	O	0..1	String	SDNC description
productName	O	0..1	String	SDNC productName
protocol	O	0..1	Enum{netconf/snmp}	protocol
userName	O	0..1	String	User name
password	O	0..1	String	Password

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

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

Response Parameters:
SDN Controller

Response Sample:

   {
       "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":"ODL",
       "createTime":"2016-07-18 12:22:53"
   }

...

Interface Definition Description
URI /onapapiapi/aai/-esr-server/v1/sdncontrollersemses/{sdnControllerIdemsId}
Operation Type DELETE
Request Parameters:
Attribute Qualifier Cardinality Content Description
sdnControllerIdemsId M 1 String SDN Controller EMS identifier
Request Sample:
/onapapiapi/aai/-esr-server/v1/sdncontrollersemses/5767478619ecbb3a-5b2e3242-4c924fa3-bb689926-578dbd79e2f58dfb7ddc29ee
Response Parameters:N/A
Response Sample:
N/A

EMS

...

Success Code: 204

Errorcode: 500 Internal Server Error

PNF

PNF registration

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/emsespnfs
Operation Type	POST

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description


pnfId	M	1	String	unique ID of PNF
userLabel

name

M

1

String

EMS

PNF system name

vendor

subnetId

M

1

String

vendorversion

subnet ID of DU network element
neId	M	1	String

version

network element ID

description

managementType

O

0..

1

String

descriptionproductName


vendor	O

0..

1

String

productNameurl


pnfdId	M	1	String

Access urluserName


emsId	M	1	String

User namepassword


lattitude	O	1	String
longitude	O

M

1

String

Password

Request Sample:
/onapapiapi/aai/-esr-server/v1/emsespnfs

Body:

       "pnfId":"dafdaf3213dfa",

       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",   {
       "namemanagementType":"emstest",
       "vendor":"ZTEzte",
       "versionpnfdId":"v1.08f7adfa8fa9",
       "descriptionemsId":"fdsa5f4afd4a",
       "productNamelattitude":"156.446",
       "urllongitude":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin"
   }

Response Parameters:
EMS

Response Sample:

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

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

   {
       "emsIdpnfId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29eedafdaf3213dfa",


       "nameuserLabel":"emspnf1",
       "vendorsubnetId":"ZTE15da65fa1f",
       "versionneId":"v1.04f6asd8ff4asd",
       "descriptionmanagementType":"test",
       "productNamevendor":"zte",
       "urlpnfdId":"http://10.74.44.118f7adfa8fa9",
       "userNameemsId":"adminfdsa5f4afd4a",
       "passwordlattitude":"admin156.446",
       "createTimelongitude":"2016-07-18 12:22:53121.154"
   }

Response:

Success Code: 200

Errorcode: 500 Internal Server Error

Get

...

PNF by

...

ID

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

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-8dfb7ddc29eepnfs/dafdaf3213dfa

Response Parameters:
EMS PNF

Response Sample:

Success Code: 200

       "emsIdpnfId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29eedafdaf3213dfa",


       "nameuserLabel":"emspnf1",
       "versionsubnetId":"v1.015da65fa1f",
       "vendorneId":"ZTE4f6asd8ff4asd",
       "descriptionmanagementType":"test",
       "productNamevendor":"zte",
       "urlpnfdId":"http://10.74.44.118f7adfa8fa9",
       "userNameemsId":"adminfdsa5f4afd4a",
       "passwordlattitude":"admin156.446",
       "createTime":"2016-07-18 12:22:53longitude":"121.154"
   }

Get all

...

PNF

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/emsspnfs
Operation Type	GET

Request Parameters:
N/A

Request Sample:
/onapapiapi/aai/-esr-server/v1/emsspnfs

Response Parameters:
List<EMS PNF>

Response Sample:

Success Code: 200 [

          "emsIdpnfId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29eedafdaf3213dfa",


           "nameuserLabel":"emspnf1",
           "versionsubnetId":"v1.015da65fa1f",
           "vendorneId":"ZTE4f6asd8ff4asd",
           "descriptionmanagementType":"test",
           "productNamevendor":"zte",
           "urlpnfdId":"http://10.74.44.118f7adfa8fa9",
           "userNameemsId":"adminfdsa5f4afd4a",
           "passwordlattitude":"admin156.446",
           "createTimelongitude":"2016-07-18 12:22:53121.154"
       }
   ]

Update EMS

Interface Definition	Description
URI	/onapapi/aai/esr/v1/emses/{emsId}
Operation Type	PUT

Request Parameters:

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

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	O	0..1	String	VNFM UUID generated by ESR
name	M	1	String	VNFM name
type
Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	StringEMS	identifierVNFM type
namevimId	O	0..1	StringEMS	nameRelated VIM
vendor	OM	0..1	StringVendor	VNFM vendor
version	OM	0..1	String	VNFM version
descriptioncertificateUrl	O	0..1	Stringdescription	certificate url
productNameurl	OM	0..1	StringproductName	Access urlurl
userName	O	0..1	StringAccess	urlUser name
userNamepassword	O	0..1	String	User name
password	O	0..1	String	Password

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

   {
       "emsId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"ems",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "productName":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin"
   }

Response Parameters:
EMS

Response Sample:

   {
       "emsId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"ems",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "productName":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
       "createTime":"2016-07-18 12:22:53"
   }

Delete EMS

Interface Definition	Description
URI	/onapapi/aai/esr/v1/emses/{emsId}
Operation Type	DELETE

Password

VIM

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

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

emsId

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	EMS identifier

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

Response Parameters:
N/A

Response Sample:
N/A

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
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
instanceId	M	1	String	External system identifier

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

Response Parameters:

Attribute	Content	Description
instanceId	String	External system identifier(UUID)
category	Enum{VIM/VNFM/SDNC/EMS}	External system category
name	String	External system name
description	String	External system description
version	String	External system version
vendor	String	External system vendor
type	String	External system type
createTime	String	Create time

Response Sample:

   {
       "instanceId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "category":"VNFM",
       "name":"vnfm",
       "description":"",
       "version":"v1.0",
       "vendor":"ZTE",
       "type":"Tacker",
       "createTime":"2016-07-18 12:22:53"
   }

Information elements

VNFM

Attribute	Content	Description
vnfmId	String	VNFM identifier(UUID)
name	String	VNFM name
description	String	VNFM description
version	String	VNFM version
vendor	String	VNFM vendor
type	String	VNFM type
url	String	Access url
userName	String	User name
password	String	Password
createTime	String	Create time
vimId	String	Related VIM
certificateUrl	String	VNFM certificate url

VIM

Attribute	Content	Description
vimId	String	VIM identifier(UUID)
name	String	VIM name
description	String	VIM description
version	String	VIM version
vendor	String	VIM vendor
type	Enum{openstack/vmware}	VIM type
url	String	Access url
userName	String	User name
password	String	Password
createTime	String	Create time
tenant	String	Tenant name
domain	String	VIM domain

SDN Controller

...

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

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

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

EMS

AttributeContentDescriptionemsIdStringEMS identifier(UUID)nameStringEMS namedescriptionStringdescriptionversionStringversionvendorStringVendorurlStringAccess urluserNameStringUser namepasswordStringPasswordcreateTimeStringCreate timeproductNameStringproduct name

Qualifier	Cardinality	Content	Description
cloudOwner	M	1	String	Cloud owner
cloudRegionId	M	1	String	Cloud region

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

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 2

New Version Current

Key

VIM

VIM registration

Update VIM info

VNFM

VNFM registration

Get VNFM by id

Get VIM

Get all VIM

Delete VIM

VNFM

VNFM registration

Update VNFM

Delete VNFM

VNFM update

VIM

VIM registration

Get VNFM

Get

all VNFM

Delete VNFM

Update VIM

SDN Controller

SDN Controller registration

Update SDN Controller info

Get SDN Controller

Get all SDN Controller

SDN Controller

SDN Controller registration

Delete SDN Controller

EMS

EMS registration

Get SDN Controller by id

Update EMS info

Get EMS by id

Get all EMS

Delete EMS

Get all SDN Controller

Update SDN Controller

EMS

PNF

PNF registration

Update PNF info

Get

PNF by

ID

Get all

PNF

Update EMS

Delete PNF

Information elements

VNFM

Delete EMS

VIM

SDN Controller

Other

Get basic info by id

Information elements

VNFM

VIM

SDN Controller

EMS

resourceAddr

performanceAddr

alarmAddr

PNF

EMS