Table of Contents

VIM

...

VIM registration

Interface Definition

Description

URI

/

onapapi

api/aai

/

-esr-server/v1/

vnfms

vims

Operation Type

PUTPOST

Request ParametersBody:

0..1

Attribute	Qualifier	CardinalityDefault	Content	Description
cloudOwner	vnfmIdM	O	0..1	String	VNFM UUID generated by ESR
name	M	1	String	VNFM name
type	M	1	String	VNFM type
vimId	O	0..1	String	Related VIM
vendor	M	1	String	VNFM vendor
version	M	1	String	VNFM version
description	O	0..1	String	VNFM description
certificateUrl	O	0..1	String	certificate url
url	M	1	String	Access url
userName	O
	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

O0..1String

	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

Password

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

Body:

   {
       "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",       "name":"vnfm",
       "type":"Tacker",
       "vimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"vnfm",
       "url":"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.44.11",
       "certificateUrl":"",
       "userName":"admin",
       "password":"admin"
   }
.151.13:5000/v2.0",
 "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	/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

...

		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/

vnfms

vims/{cloudOwner}/{cloudRegionId}

Operation Type

GET

Request Parameters:
N/A

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

Request Sample:
/onapapiapi/aai/-esr-server/v1/vnfmsvims/ZTE/region-one

Response Parameters:
List<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"
       }
   ]

Update VNFM

...

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

Attribute	Qualifier	Cardinality	Content	Description
name	M	1	String	VNFM name
type
Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifiertype
namevimId	O	0..1	StringVNFM	nameRelated VIM
vendor	OM	0..1	String	VNFM vendor
urlversion	M	1	String	VNFM version
certificateUrl	O	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/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Body:

       "name":"vnfm",


       "vnfmIdtype":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29eeTacker",
       "namevimId":"vnfm",
       "vendor":"ZTE",
       "version":"v1.0",
       "url":"http://10.74.44.11",
       "userNamecertificateUrl":"admin",
       "userName":"admin",
       "password":"admin"
   }

Response Parameters::

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

}

Success Code: 201200

Errorcode: 500 Internal Server Error

...

VNFM update

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

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:

Success Code: 204

Errorcode: 500 Internal Server Error

VIM

VIM registration(Update VIM)

...

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

...

type	M	1	String	VNFM type
vimId	O	0..1	String	Related VIM
vendor	M	1	String	VNFM vendor
version

Request Body:

Attribute	Qualifier	Cardinality	Content	Description
cloud-owner	M	1	String	Cloud owner
cloud-regionId	M	1	String	Cloud region
auth-info	M	1	Obj	Auth information of Cloud

authInfo:

Description

VNFM version
certificateUrl	O	0..1	String	certificate url	Attribute	Qualifier	Cardinality	Content
url	M	1	String	Access url
userName	MO	0..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
type	M	1	String	VIM type
Password

Request Sample:
/api/aai-cloudInfrastructureesr-server/v1/vnfms/cloud-regions/cloud-region/owner/region-one19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

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":"ZTE",
       "version":"v1.0",
       "type":"openstack"       }admin"
   }

Response:

Success Code: 201200

Errorcode: 500 Internal Server Error

Get

...

VNFM

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
cloudOwnervnfmId	M	1	String	Cloud owner
cloudRegionId	M	1	String	Cloud region
VNFM identifier

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

Response Parameters:

VIM

Get all VIM

...

Request Parameters:
N/A

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

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

Response Parameters:
List<VIM>VNFM

Response Sample:

Success

...

Code:

...

200

 [
       {
       "cloud-ownervnfmId":"owner19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "cloud-regionname":"region-onevnfm",
       "authInfotype": {"Tacker",
       "urlvimId":"http://10.74.151.13:5000/v2.0",
       "userNamevendor":"adminZTE",
       "passwordversion":"adminv1.0",
       "tenantcertificateUrl":"admin",
       "domainurl":"http://10.74.44.11",
       "vendoruserName":"ZTEadmin",
       "versionpassword":"v1.0admin",
       "type":"openstack"

       }
   ]

...

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

Response Parameters:
List<VNFM>

Response Sample:

Success Code:

...

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration

...

Request Parameters:

...

 [
       {
           "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
           "name":"vnfm",
           "type":"Tacker",
           "vimId":"",
           "vendor":"ZTE",
           "version":"v1.0",
           "certificateUrl":"",

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

   {
       "name":"sdn",
       "url":"http://10.74.15144.13:818111",
           "userName":"admin",
       "password":"admin",
         "versionpassword":"v1.0admin",
       "vendor":"ZTE",}
       "description":"",
       "protocol":"netconf",
       "productName":"",
       "type":"WAN"
   }
]

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

Errorcode: 500 Internal Server Error

SDN Controller

...

SDN Controller

...

registration

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

Request Parameters:

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

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

Response Parameters:
SDN Controller

Response Sample:

Success Code: 201

...

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

Request Parameters:N/A

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

...

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

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

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",    {
       "sdnControllerIdversion":"a6c42529-cd6b-4c01-b149-03eb54b20a03v1.0",
       "namevendor":"sdnZTE",
       "urldescription":"http://10.74.151.13:8181",
       "userNameprotocol":"adminnetconf",
       "passwordproductName":"admin",
       "versiontype":"v1.0WAN",
       "vendor":"ZTE",
       "description}

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

 [":"",
       "protocol":"netconf",{
       "productName":""
   }

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

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:

1

Attribute	Qualifier	Cardinality	Content	Description	emsId	M
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

...

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

...

}

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

"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

...

Request Parameters:

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

...

	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:

...

alarmAddr:

...

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"

...

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

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

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

...

Interface Definition
Description
URI /onapapiapi/aai/-esr-server/v1/emses/{emsId}pnfs
Operation Type DELETEPOST
Request Parameters:
Attribute
Qualifier
Cardinality
Content
Description
emsId
pnfId 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:

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

AttributeQualifierCardinalityContentDescriptioninstanceIdM1StringExternal system identifier

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

Response Parameters:

...

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

       "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

Get PNF by ID

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
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",

       "userLabel":"pnf1",

Response Sample:

   {
       "instanceIdsubnetId":"15da65fa1f",
       "neId":"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()

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

VIM

Attribute	Qualifier	CardinalityDefault	Content	Description
cloudOwner	M1		StringCloud	ownercloud owner name, can be customized, e.g. att-aic
cloudRegionId	M1		String	Cloud region
cloud-type	O	0...1	String	Type of the cloud (e.g., openstack)
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	owner-defined-type	O	0...1		String	Cloud-owner defined type indicator
cloud-region-version	O	0...1	String	Software version employed at the site
identity-url	O	0...1	String	URL of the keystone identity service
(e.g., dcp, lcp)
cloudZone	O	cloud-zone	O	0...1		String	Zone where the cloud is homed.
complex-namecomplexName	O0...1		String	complex name for cloud-region instance	complex name for cloud-region instance.
cloudExtraInfo	O	resource-version	O	0...1		String	Used for optimistic concurrency. Must be empty on create, valid on update and delete.
volume-groups	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

...

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

...

Attribute Qualifier Cardinality Content Description
urlemsId M 1 StringAccess urlEMS identifier
userNamename MO 0..1 String User EMS name
passwordvendor MO 0..1 String PasswordVendor
tenantversion MO 0..1 String Tenant nameversion
domaindescription O 0..1 String Domain
vendor M 1 String VIM vendor
version M 1 String VIM version
type M 1 String VIM type
...

EMS

...

	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

resourceAddr:

Attribute	Content	Description
ftptype	Enum{ftp/sftp}	ftp type
ip	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

remotepath

Stringresource data file pathpassiveBooleanftp passive mode or not

performanceAddr:

...

alarmAddr:

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

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

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

Attribute	Qualifier	Cardinality	Content	Description
urlemsId	M	1	StringAccess	urlEMS identifier
userNamename	MO	0..1	String	User EMS name
passwordvendor	MO	0..1	String	PasswordVendor
tenantversion	MO	0..1	String	Tenant nameversion
domaindescription	O	0..1	String	Domain
vendor	M	1	String	VIM vendor
version	M	1	String	VIM version
type	M	1	String	VIM type

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 15

New Version Current

Key

VIM

VIM registration

Update VIM info

Get VIM

Update VNFM

Get all VIM

Delete VIM

VNFM

VNFM registration

VNFM update

VIM

VIM registration(Update VIM)

Get

VNFM

Get all VIM

Get all VNFM

SDN Controller

SDN Controller registration

Delete VNFM

SDN Controller

SDN Controller

registration

Update SDN Controller info

Get SDN Controller

Get all SDN Controller

Delete SDN Controller

EMS

EMS

registration

Update EMS info

Get EMS by id

Get all EMS

Get EMS by id

Get all EMS

Delete EMS

PNF

PNF registration

Other

Get basic info by id

Update PNF info

Get PNF by ID

Get all PNF

Delete PNF

Information elements

VNFM

VIM

volume-group

SDN Controller

EMS

EMS

resourceAddr

performanceAddr

alarmAddr

PNF