Table of Contents

VIM

...

VIM registration

...

Interface Definition

Description

URI

/api/aai-esr-

vnfm

server/v1/

vnfms/vnfm/{vnfmId}

vims

Operation Type

PUTPOST

Request ParametersBody:

1typePassword

Attribute	Qualifier	CardinalityDefault	Content	Description
vnfmId	O	0..1	String	VNFM UUID generated by ESR
cloudOwner	M	name	M			String	VNFM name	cloud owner name, can be customized, e.g. att-aic
cloudRegionId		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
	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-vnfmesr-server/v1/vnfms/vnfm/19ecbb3a-3242-4fa3-9926-8dfb7ddc29eevims

Body:

   {
 "cloudOwner":      "vnfmId"ZTE",
 "cloudRegionId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29eeregion-one",
       "namecloudType": "vnfmopenstack",
      
 "typecloudRegionVersion": "Tackerv1.0",
       "vimId
 "ownerDefinedType": "owner-defined-type",

 "cloudZone": "cloud zone",
 "complexName": "complex name",
 "vendorcloudExtraInfo": "ZTEcloud-extra-info",

 "vimAuthInfos": 
 [{
    "versionuserName": "v1.0admin",
       "description
 "password": "vnfmadmin",
      
 "urlauthUrl": "http://10.74.44.11.151.13:5000/v2.0",

       "certificateUrl":"",
       "userName":"admin",
       "password":"admin"
   }
"sslCacert": "ssl-cacert",
 "sslInsecure": true,
 "cloudDomain": "cloud-domain"
 }]
}

Response:

Success Code: 201: 200

body:

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

Errorcode: 500 Internal Server Error

...

Update VIM info

Interface Definition	Description
URI	/api/aai-esr-vnfmserver/v1/vnfmsvims/vnfm/{vnfmId{cloudOwner}/{cloudRegionId}
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
/api/aai-esr-
vnfm
server/v1/
vnfms
vims/
vnfm
{cloudOwner}/{
vnfmId
cloudRegionId}
Operation Type DELETEGET
Request Parameters:
vnfmIdVNFM identifier
Attribute Qualifier Cardinality Content Description
cloudOwner M 1 String Cloud owner
cloudRegionId M 1 String Cloud region
Request Sample:
/api/aai-esr-vnfmserver/v1/vnfmsvims/vnfmZTE/19ecbb3a-3242-4fa3-9926-8dfb7ddc29eeregion-one
Response Parameters:
Success Code: 204
Errorcode: 500 Internal Server Error

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-cloudInfrastructureserver/v1/cloud-regions/cloud-regionvims/{cloud-ownercloudOwner}/{cloud-region-idcloudRegionId}
Operation Type PUTDELETE
Request BodyParameters:
cloud-owner
Attribute Qualifier Cardinality Content Description
vimId M 1 String Cloud owner
cloud-regionId M 1 String Cloud region
auth-info M 1 Obj Auth information of Cloud
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 ParametersauthInfo:

Attribute	Qualifier	Cardinality	Content	Description
urlname	M	1	StringAccess	urlVNFM name
userNametype	M	1	String	User name	VNFM type
vimId	O	0..1	String	Related VIM
vendorpassword	M	1	StringPassword	VNFM vendor
tenantversion	M	1	StringTenant	nameVNFM version
domaincertificateUrl	O	0..1	StringDomain	certificate url
vendorurl	M	1	StringVIM	vendorAccess url
versionuserName	MO	0..1	StringVIM	versionUser name
typepassword	MO	0..1	String	VIM typePassword

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

{

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

vnfms

Body:

       "name":"vnfm",

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

Response:

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

}

Success Code: 200Success Code: 201

Errorcode: 500 Internal Server Error

...

VNFM update

Interface Definition	Description
URI	/api/aai-cloudInfrastructureesr-server/v1/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-idvnfms/{vnfmId}
Operation Type	GETPUT

Request Parameters:

cloudRegionId

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

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

Response Parameters:

VIM

Get all VIM

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

       "cloud-ownertype":"ownerTacker",
       "cloud-regionvimId":"region-one",
       "authInfovendor": {"ZTE",
       "version":"v1.0",
       "url":"http://10.74.151.13:5000/v2.044.11",
       "userNamecertificateUrl":"admin",
       "passworduserName":"admin",
       "tenantpassword":"admin",
       "domain":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "type":"openstack"

       }
   ]

Delete VIM

Response:

Success Code: 200

Errorcode: 500 Internal Server Error

Get VNFM

Interface Definition	Description
URI	/api/aai-esr-server/v1/vnfms/{vnfmId}
Operation Type	GET
Interface Definition	Description
URI	/onapapi/aai/esr/v1/vims?cloudOwner=xxx&cloudRegionId=xxx
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vimIdvnfmId	M	1	String	VIM VNFM identifier

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

Response Parameters:
VNFM

Response SampleResponse:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration (Update SDN Controller)

...

Request Parameters:

...

sdnControllerId

...

200

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

Get all VNFM

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

Request Parameters:
N/A

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

Response Parameters:
List<VNFM>

Response Sample:

Success Code: 200

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

Delete VNFM

Request Sample:
/api/aai-sdncontroller/v1/sdncontrollers/sdncontroller/{sdnControllerId}

{

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

}

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

Get SDN Controller

Interface Definition	Description
URI	/api/aai-esr-sdncontrollerserver/v1/sdncontrollers/sdncontrollervnfms/{sdnControllerIdvnfmId}
Operation Type	GETDELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerIdvnfmId	M	1	String	SDN Controller VNFM identifier

Request Sample:
/api/aai-esr-sdncontrollerserver/v1/sdncontrollersvnfms/sdncontroller/5767478619ecbb3a-5b2e3242-4c924fa3-bb68-578dbd79e2f5Response Parameters:
SDN Controller9926-8dfb7ddc29ee

Response Sample:

Success Code: 201
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}
Operation Type	PUT

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

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

Get all SDN Controller

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:   {
       "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	/api/aai-esr-sdncontrollerserver/v1/sdncontrollers/{sdnControllerId}
Operation Type	GETDELETE

Request Parameters:
N/A

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

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

Response Parameters:
List<SDN Controller>

Response Sample:

Success Code: 201

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

...

Request Parameters:

...

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

EMS

EMS registration

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

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

...

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
ip	M	1	String	service IP of ftp server
portemsId	M	1	String	UUID generated by esr-server
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:

...

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

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

ipportftp user name

Attribute	Qualifier	Cardinality	Content	Description
ftptypename	M	1	Enum{ftp/sftp}	ftp type	String	EMS name
vendor		M	1	String	service IP of ftp server	vendor
version		M	1	String	service port of ftp server	user	M	version
description	O	0..1	String	description
passwordresourceAddr	M	1	String	ftp password	Obj	Address to get resource data
performanceAddrremotepath	M	1	StringObj	Address to get performance data file path
passivealarmAddr	M	1	Boolean	ftp passive mode or not	Obj	Address to get alarm data

resourceAddralarmAddr:

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

Request Sample:

/api/aai-ems/v1/emses/ems/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"

"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 Parameters:
EMS

Response Sample:

{

...


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

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

...

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

}

Get EMS by id

Interface Definition	Description
URI	/api/aai-esr-emsserver/v1/emses/ems/{emsId}
Operation Type	GET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier

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

...

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

...

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

}

Get all EMS

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

Request Parameters:
N/A

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

Response Parameters:
List<EMS>

Response Sample:

Success Code: 201200

[

{

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

...

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

...

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

}

]

...

Delete EMS

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier

emsId	M	name	O	0..1	String	EMS nameidentifier
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:

...

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

performanceAddr:

...

alarmAddr:

Attribute	Qualifier	Cardinality	Content	Description

ip

pnfId

O

M

0..0..

1

String

service IP of ftp serverportO

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

0..

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
emsId	M	1	String	EMS identifier

Request Sample:
/onapapi/aai/esr/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:

...


pnfId	M	1	String	PNF identifier

Request Sample:
/api/aai-esr-server/v1/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",

Response Sample:

   {
       "instanceIduserLabel":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29eepnf1",
       "categorysubnetId":"VNFM15da65fa1f",
       "nameneId":"vnfm4f6asd8ff4asd",
       "descriptionmanagementType":"test",
       "versionvendor":"v1.0zte",
       "vendorpnfdId":"ZTE8f7adfa8fa9",
       "typeemsId":"Tackerfdsa5f4afd4a",
       "createTime":"2016-07-18 12:22:53"
   }

Information elements

VNFM

...

lattitude":"156.446",
       "longitude":"121.154"
   }

Delete PNF

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

Request Parameters:

...

cloudOwner

Attribute	Qualifier	Cardinality	Content	Description
pnfId	M	1	String	Cloud owner
cloudRegionId	M	1	String	Cloud region
	PNF identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

Information elements

VNFM

0...Cloud-owner defined indicator.0...cloud-zone.0...resource-version.volume-groups.

Attribute	Qualifier	Cardinality	Content	Description
vnfmIdcloud-type	O	0...1	String	VNFM UUID generated by ESR
name	M	1	String	Type of the cloud (e.g., openstack)	owner-defined-type	O	VNFM name
type	M	1	String	VNFM type	cloud-region-version
vimId	O	0..	1	String	Related VIM
vendor	M	1	String	Software version employed at the site	identity-url	O	VNFM vendor
version	M	1	String	URL of the keystone identity service	VNFM version
certificateUrl		O	0..	1	String	Zone where the cloud is homed	complex-name	O	certificate url
url	M	1	String	complex name for cloud-region instance	Access url
userName	O	0..	1	String	Used for optimistic concurrency. Must be empty on create, valid on update and delete.	User name
password		O	0	..1	object[]	definition detail see AAI API
tenants	O	0...1	object[]	definition detail see AAI API
flavors	O	0...1	object[]	definition detail see AAI API
group-assignments	O	0...1	object[]	definition detail see AAI API
snapshots	O	0...1	object[]	definition detail see AAI API
images	O	0...1	object[]	definition detail see AAI API
availability-zones	O	0...1	object[]	definition detail see AAI API
relationship-list	O	0...1	object[]	definition detail see AAI API
authInfo	M	1	Obj	Auth information of Cloud

volume-group

...

String

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

urlM

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	Access url
userName	M	1	String	User name
UUID of sdncontroller
namepassword	M	1	StringPassword	SDN Controller nametenant
location	O	1	String	Tenant name	fit for DC type
url	M	domain	O	0..1	StringDomain	Access url
vendor	M	1	String	VIM SDNC vendor
version	M	1	String	VIM SDNC version
typedescription	MO	0..1	String	VIM type

SDN Controller

sdnControllerIdlocationO

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

EMS

Attribute	Qualifier	Cardinality	Content	Description
emsIdvendor	M	1	StringSDNC	vendorEMS identifier
versionname	MO	0..1	StringSDNC	versionEMS name
descriptionvendor	O	0..1	String	SDNC descriptionVendor
productNameversion	O	0..1	String	SDNC productNameversion
protocoldescription	MO	0..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

...

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

vendorversiondescriptiondescriptionresourceAddrperformanceAddralarmAddr

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier
ftptype	name	O	0..1	String	EMS name	Enum{ftp/sftp}	ftp type
ip		O	0..1	String	Vendor	service IP of ftp server
port		O	0..1	String	version	service port of ftp server
user		O	0..1	String	ftp user name
password	O	0..1	Obj	Address to get resource data	String	ftp password
remotepath		O	0..1	Obj	Address to get performance data	String	resource data file path
passive		O	0..1	Obj	Address to get alarm data

...

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

resource

performance data file path
passive	O	0..1	Boolean	ftp passive mode or not

...

alarmAddr

Attribute	Qualifier	Cardinality	Content	Description

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

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

ftp passwordremotepathO0..

subnet ID of DU network element
neId	M	1	String

performance data file pathpassive

network element ID
managementType	O

0..AttributeQualifierCardinalityContentDescriptionipO0..

1

Booleanftp passive mode or not

alarmAddr:

String
vendor	O	1	String
pnfdId	M

1

String

service IP of ftp serverportO0..


emsId	M	1	String

service port of ftp serveruser


lattitude	O

0..

1

String

ftp user namepassword


longitude	O

0..

1

String

ftp password

Interface Definition	Description
URI	/api/aai-esr-cloudInfrastructureserver/v1/cloud-regions/cloud-regionvims/{cloud-ownercloudOwner}/{cloud-region-idcloudRegionId}
Operation Type	PUTDELETE

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 17

New Version Current

Key

VIM

VIM registration

Update VIM info

Get all VNFM

Get VIM

VIM

Get all VIM

Delete VIM

VNFM

VNFM registration

VNFM update

Get all VIM

Delete VIM

Get VNFM

SDN Controller

SDN Controller registration (Update SDN Controller)

Get all VNFM

Delete VNFM

Get SDN Controller

SDN Controller

SDN Controller registration

Update SDN Controller info

Get SDN Controller

Get all SDN Controller

Delete SDN Controller

Delete SDN Controller

EMS

EMS registration

EMS

EMS registration

Update EMS info

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

Information elements

VNFM

Delete PNF

Information elements

VNFM

volume-group

VIM

SDN Controller

SDN Controller

EMS

resourceAddr

performanceAddr

alarmAddr

PNF