VNFM

VNFM registration

Interface Definition	Description
URI	/onapapi/aai/esr/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	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	Password

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

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

Response Parameters:
VNFM

Response Sample:

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

Get VNFM by id

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier

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

Response Parameters:
VNFM

Response Sample:

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

Get all VNFM

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

Request Parameters:
N/A

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

Response Parameters:
List<VNFM>

Response Sample:

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

Update VNFM

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier
name	O	0..1	String	VNFM name
vendor	O	0..1	String	VNFM vendor
url	O	0..1	String	Access url
userName	O	0..1	String	User name
password	O	0..1	String	Password

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

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

Response Parameters:
VNFM

Response Sample:

   {
       "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"vnfm",
       "type":"Tacker",
       "vimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"vnfm",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
       "createTime":"2016-07-06 15:33:18"
   }

Delete VNFM

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vnfmId	M	1	String	VNFM identifier

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

Response Parameters:
N/A

Response Sample:
N/A

VIM

VIM registration

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
name	M	1	String	VIM name
cloudOwner	M	1	String	Cloud owner
cloudRegion	M	1	String	Cloud region
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
description	O	0..1	String	VIM description
type	M	1	Enum{openstack/vmware}	VIM type

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

   {
       "name":"vim",

       "cloud-owner":"owner",

       "cloud-region":"region-one",
       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "password":"admin",
       "tenant":"admin",
       "domain":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "type":"openstack"
   }

Response Parameters:
VIM

Response Sample:

   {
       "name":"vim",

       "cloud-owner":"owner",

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

       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "password":"admin",
       "tenant":"admin",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "domain":"",
       "type":"openstack",
       "createTime":"2016-07-18 12:22:53"
   }

Get VIM by conditions

Interface Definition	Description
URI	/onapapi/aai/esr/v1/vims?cloud_owner=xxx&cloud_region=xxx
Operation Type	GET

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
cloud_owner	M	1	String	VIM identifier

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

Response Parameters:
VIM

Response Sample:

   {
       "name":"vim",

       "cloud-owner":"owner",

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

       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "password":"admin",
       "tenant":"admin",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "domain":"",
       "type":"openstack",
       "createTime":"2016-07-18 12:22:53"
   }

Get all VIM

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

Request Parameters:
N/A

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

Response Parameters:
List<VIM>

Response Sample:

   [
       {
           "name":"vim",

           "cloud-owner":"owner",

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

           "url":"http://10.74.151.13:5000/v2.0",
           "userName":"admin",
           "password":"admin",
           "tenant":"admin",
           "vendor":"ZTE",
           "version":"v1.0",
           "description":"",
           "domain":"",
           "type":"openstack",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

Update VIM

Interface Definition	Description
URI	/onapapi/aai/esr/v1/vims?cloud_owner=xxx&cloud_region=xxx
Operation Type	PUT

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
name	O	0..1	String	VIM name
cloudOwner	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
vendor	O	0..1	String	VIM vendor

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

   {
       "name":"vim",

       "cloud-owner":"owner",

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

       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "password":"admin",
       "tenant":"admin",
       "domain":"",
       "version":"v2.0"
   }

Response Parameters:
VIM

Response Sample:

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

Delete VIM

Interface Definition	Description
URI	/onapapi/aai/esr/v1/vims/{vimId}
Operation Type	DELETE

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
vimId	M	1	String	VIM identifier

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

Response Parameters:
N/A

Response Sample:
N/A

SDN Controller

SDN Controller registration

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
name	M	1	String	SDN Controller name
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{ODL/ONOS}	SDN Controller type

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

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

Response Parameters:
SDN Controller

Response Sample:

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

Get SDN Controller by id

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

Request Parameters:

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

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

Response Parameters:
SDN Controller

Response Sample:

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

Get all SDN Controller

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

Request Parameters:
N/A

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

Response Parameters:
List<SDN Controller>

Response Sample:

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

Update SDN Controller

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

Request Parameters:

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

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

   {
       "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
       "name":"sdn",
       "url":"http://10.74.151.13:8181",
       "userName":"admin",
       "password":"admin",
       "version":"v1.0",
       "vendor":"ZTE",
       "description":"",
       "protocol":"netconf",
       "productName":""
   }

Response Parameters:
SDN Controller

Response Sample:

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

Delete SDN Controller

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

Request Parameters:

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

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

Response Parameters:
N/A

Response Sample:
N/A

EMS

EMS registration

Interface Definition	Description
URI	/onapapi/aai/esr/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
productName	O	0..1	String	productName
url	M	1	String	Access url
userName	M	1	String	User name
password	M	1	String	Password

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

   {
       "name":"ems",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "productName":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin"
   }

Response Parameters:
EMS

Response Sample:

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

Get EMS by id

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

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

Response Sample:

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

Get all EMS

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

Request Parameters:
N/A

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

Response Parameters:
List<EMS>

Response Sample:

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

Update EMS

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

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

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

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

Response Parameters:
EMS

Response Sample:

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

Delete EMS

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

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 Parameters:
N/A

Response Sample:
N/A

Other

Get basic info by id

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

Request Parameters:

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

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

Response Parameters:

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

Response Sample:

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

Information elements

VNFM

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

VIM

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

SDN Controller

Attribute	Content	Description
sdnControllerId(UUID)	String	SDN Controller identifier
name	String	SDN Controller name
description	String	description
version	String	version
vendor	String	vendor
type	Enum{WAN/DC}	SDN Controller type
url	String	Access url
userName	String	User name
password	String	Password
createTime	String	Create time
protocol	Enum{netconf/snmp}	protocol
productName	String	productName
location	String	only fit for DC type

EMS

Attribute	Content	Description
emsId	String	EMS identifier(UUID)
name	String	EMS name
description	String	description
version	String	version
vendor	String	Vendor
createTime	String	Create time
productName	String	product name
resource	resourceInfo	resource data access address
performance	performanceInfo	performance data access address
alarm	alarmInfo	alarm data access address

resouceInfo:

Attribute	Content	Description
ftpType	Enum{ftp/sftp}
ip	String
port	String
user	String
password	String
remotePath	String
passive	Boolean

performanceInfo:

Attribute	Content	Description
ftpType	Enum{ftp/sftp}
ip	String
port	String
user	String
password	String
remotePath	String
passive	Boolean

alarmInfo:

Attribute	Content	Description
ip	String
port	String
user	String
password	String

A&AI: External System Register API Definition(draft)

VNFM

VNFM registration

Get VNFM by id

Get all VNFM

Update VNFM

Delete VNFM

VIM

VIM registration

Get VIM by conditions

Get all VIM

Update VIM

Delete VIM

SDN Controller

SDN Controller registration

Get SDN Controller by id

Get all SDN Controller

Update SDN Controller

Delete SDN Controller

EMS

EMS registration

Get EMS by id

Get all EMS

Update EMS

Delete EMS

Other

Get basic info by id

Information elements

VNFM

VIM

SDN Controller

EMS