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

Update VNFM

...

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	M	1	String	VNFM type
vimId	O	0..1	String	Related VIM
vendor

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifiervendor
nameversion	OM	0..1	String	VNFM nameversion
vendorcertificateUrl	O	0..1	StringVNFM	vendorcertificate url
url	OM	0..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:


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


       "nametype":"vnfmTacker",
       "vendorvimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "url":"http://10.74.44.11",
       "certificateUrl":"",
       "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

...

Request Parameters:

cloudOwnerCloud ownercloudRegionMCloud region

Attribute	Qualifier	Cardinality	Content	Description
type	M	1	String	VNFM type
vimId	O	0..1	String	Related VIM
vendor
name	M	1	StringVIM	nameVNFM vendor
version	M	1	String	VNFM version
certificateUrl	O	0..1	String	certificate url
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
password	description	O	0..1	String	VIM description
type	M	1	Enum{openstack/vmware}	VIM type
Password

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

Body:


       "name":"vimvnfm",

       "cloud-ownertype":"ownerTacker",
       "cloud-regionvimId":"region-one",
       "urlvendor":"http://10.74.151.13:5000/v2.0ZTE",
       "userNameversion":"adminv1.0",
       "passwordurl":"adminhttp://10.74.44.11",
       "tenantcertificateUrl":"admin",
       "domainuserName":"admin",
       "vendorpassword":"ZTEadmin",
       "version":"v1.0",
       "description":"",
       "type":"openstack"
   }
}

ResponseResponse:

Success Code: 201200

Errorcode: 500 Internal Server Error

Get

...

VNFM

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/vims?cloud_owner=xxx&cloud_region=xxx/vnfms/{vnfmId}
Operation Type	GET

Request Parameters:

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

Request Sample:
/onapapiapi/aai/-esr-server/v1/vims?cloud_owner=owner&cloud_region=region-onevnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response Parameters:
VIM VNFM

Response Sample:

Success

...

Code: 200

 201   {
       "namevnfmId":"vim19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "cloud-ownername":"ownervnfm",
       "cloud-regiontype":"region-oneTacker",
       "urlvimId":"http://10.74.151.13:5000/v2.0",
       "userNamevendor":"adminZTE",
       "passwordversion":"adminv1.0",
       "tenantcertificateUrl":"admin",
       "vendorurl":"ZTE",
       "version":"v1.0http://10.74.44.11",
       "descriptionuserName":"admin",
       "domainpassword":"",
       "type":"openstackadmin",
       "createTime":"2016-07-18 12:22:53"
   }

Get all

...

VNFM

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

Request Parameters:
N/A

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

Response Parameters:
List<VIM VNFM>

Response Sample:

Success Code: 201200

 [
       {
           "namevnfmId":"vim19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
           "cloud-ownername":"ownervnfm",
           "cloud-regiontype":"region-oneTacker",
           "urlvimId":"http://10.74.151.13:5000/v2.0",
           "userNamevendor":"adminZTE",
           "passwordversion":"adminv1.0",
           "tenantcertificateUrl":"admin",
           "vendorurl":"ZTEhttp://10.74.44.11",
           "versionuserName":"v1.0admin",
           "descriptionpassword":"admin",
           "domain":"",
           "type":"openstack",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

Update VIM

}
   ]

Delete VNFM

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/vims?cloud_owner=xxx&cloud_region=xxx/vnfms/{vnfmId}
Operation Type	DELETE	Operation Type	PUT

Request Parameters:

cloudOwner

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

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	UUID of sdncontroller
name	M	1	String	SDN Controller 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
descriptionvendor	O	0..1	StringVIM vendor	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:
/onapapiapi/aai/-esr-server/v1/vims?cloud_owner=owner&cloud_region=region-one

   {
       "name":"vim",

       "cloud-owner":"owner",

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

...

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

Response:

Success Code: 201

Errorcode: 500 Internal Server Error

...

Update SDN Controller info

Interface Definition	Description
URI	/onapapiapi/aai/-esr-server/v1/vims?cloud_owner=xxx&cloud_region=xxx/sdncontrollers/{sdnControllerId}
Operation Type	DELETEPUT

Request Parameters:

vimId

Attribute	Qualifier	Cardinality	Content	Description
sdnControllerId	M	1	String	VIM identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration

...

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
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 Enum{ netconf/snmp}protocol
userName	M	1	String	User name
password	M	1	String	Password
type	M	1	Enum{WAN/DC}	SDN Controller type

Request Sample:
/onapapiapi/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: 201200

Errorcode: 500 Internal Server Error

Get SDN Controller

...

Interface Definition	Description
URI	/onapapiapi/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:
/onapapiapi/aai/-esr-server/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5

...

Response Sample:

Success Code: 201200

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

Get all SDN Controller

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

Request Parameters:
N/A

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

Response Parameters:
List<SDN Controller>

Response Sample:

Success Code: 201200

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

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:

O0..

Attribute	Qualifier	Cardinality	Content	Description
name	M	1	String	EMS name
vendor	M	1	String	vendor
version	M	1	String	version
description
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 productNamedescriptionprotocol
resourceAddr	M	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:

Success Code: 201

...

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:

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

...

"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

Delete SDN Controller

...

Request Parameters:

...

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

EMS

...

Interface Definition Description
URI /onapapiapi/aai/-esr-server/v1/emses/{emsId}
Operation Type PUT
Request Parameters:
emsId
Attribute Qualifier Cardinality Content Description
name M 1 String UUID generated by esr-server name M 1 String EMS nameEMS 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
...
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 Parameters:
EMS
Response Sample:
...

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 /onapapiapi/aai/-esr-server/v1/emses/{emsId}
Operation Type GET
Request Parameters:
...
N/A
Request Sample:
/onapapiapi/aai/-esr-server/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee
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	/onapapiapi/aai/-esr-server/v1/emses/emss{emsId}
Operation Type	GETDELETE

Request Parameters:
N/A

Attribute	Qualifier	Cardinality	Content	Description
emsId	M	1	String	EMS identifier

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

Response Parameters:
List<EMS>

Response Sample:

Success Code: 201

...

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

"emsName": "EMS_TEST",

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

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

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

Update EMS

...

Request Parameters:

AttributeQualifierCardinalityContentDescription


emsId	M	1	String

EMS identifiername


lattitude	O

0..

1

String

EMS namevendor


longitude	O

0..

1

String

VendorversionO0..1StringversiondescriptionO0..1StringdescriptionresourceAddrO0..1ObjAddress to get resource dataperformanceAddrO0..1ObjAddress to get performance dataalarmAddrO0..1ObjAddress 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"

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

Success Code: 201

Errorcode: 500 Internal Server Error

Delete EMS

...

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:

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

...

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

...

EMS

...

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

Body:

       "pnfId":"dafdaf3213dfa",

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

Response:

Success Code: 200

Errorcode: 500 Internal Server Error

Update PNF info

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
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",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }

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	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
url	M	1	String	Access url
userName	O	0..1	String	User name
password	O	0..1	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

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

resourceAddr:

...

performanceAddr:

...

alarmAddr:

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

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

Attribute	Qualifier	Cardinality	Content	Description
name	M	1	String	UUID generated by esr-server	name	M	1	String	EMS nameEMS 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

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 13

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

Get

VNFM

Get all

VNFM

Update VIM

Delete VNFM

SDN Controller

SDN Controller registration

Update SDN Controller info

SDN Controller

SDN Controller registration

Get SDN Controller

Get all SDN Controller

Delete SDN Controller

EMS

EMS registration

Update EMS info

Delete SDN Controller

EMS

Get EMS by id

Get all EMS

Delete EMS

PNF

PNF registration

Update EMS

Delete EMS

Other

Get basic info by id

Information elements

VNFM

VIM

SDN Controller

EMS

Update PNF info

Get PNF by ID

Get all PNF

Delete PNF

Information elements

VNFM

VIM

SDN Controller

EMS

resourceAddr

performanceAddr

alarmAddr

PNF