Page Comparison

This API is only exposed to esr portal.

...

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
authInfoItems	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
ssl-cacert	O	String	ca file content if enabled ssl on auth-url
ssl-insecure	O	Boolean	Whether to verify VIM's certificate

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

...

Attribute	Qualifier	Content	Description
cloudType	M	String	type of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersion	M	String	cloud version, ocata, mitaka or other
ownerDefinedType	O	String	Cloud-owner defined type indicator (e.g., dcp, lcp)
cloudZone	O	String	Zone where the cloud is homed.
complexName	O	String	complex name for cloud-region instance.
cloudExtraInfo	O	String	extra info for Cloud
authInfoItems	M	[Obj]	Auth information of Cloud

...

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

Request Parameters:

...

Errorcode: 500 Internal Server Error

Update EMS info

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

Request Parameters:

Attribute	Qualifier	Cardinality	Content	Description
name	M	1	String	EMS name
vendor	M	1	String	vendor
version	M	1	String	version
description	O	0..1	String	description
resourceAddr	M	1	Obj	Address to get resource data
performanceAddr	M	1	Obj	Address to get performance data
alarmAddr	M	1	Obj	Address to get alarm data

resourceAddr:

Attribute	Qualifier	Cardinality	Content	Description
ftptype	M	1	Enum{ftp/sftp}	ftp type
ip	M	1	String	service IP of ftp server
port	M	1	String	service port of ftp server
user	M	1	String	ftp user name
password	M	1	String	ftp password
remotepath	M	1	String	resource data file path
passive	M	1	Boolean	ftp passive mode or not

performanceAddr:

Attribute	Qualifier	Cardinality	Content	Description
ftptype	M	1	Enum{ftp/sftp}	ftp type
ip	M	1	String	service IP of ftp server
port	M	1	String	service port of ftp server
user	M	1	String	ftp user name
password	M	1	String	ftp password
remotepath	M	1	String	performance data file path
passive	M	1	Boolean	ftp passive mode or not

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

...

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>

...

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

VIM

Attribute	Qualifier

Cardinality

Default	Content	Description

cloud-owner

cloudOwner

M

1

String

Cloud ownercloud-region-id

cloud owner name, can be customized, e.g. att-aic
cloudRegionId	M

1

String

Cloud

cloud region

cloud-extra-info
O0...1

info based on deployment, e.g. RegionOne
cloudType	M		String

Extra information

type of

Cloudcloud-typeO0...1StringType of the cloud (e.g., openstack)owner-defined-typeO0...1

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

cloud-region-versioncloud-zoneO0...1StringZone

(e.g., dcp, lcp)
cloudZone	O

0...1StringSoftware version employed at the siteidentity-urlO0...1StringURL of the keystone identity service

String

Zone where the cloud is homed.

complex-name

complexName

O

0...10...1

String

complex name for cloud-region instanceresource-versionO

complex name for cloud-region instance.
cloudExtraInfo	O		String

Used for optimistic concurrency. Must be empty on create, valid on update and delete.volume-groupsO0...1object[]definition detail see AAI APItenantsO0...1object[]definition detail see AAI APIflavorsO0...1object[]definition detail see AAI APIgroup-assignmentsO0...1object[]definition detail see AAI APIsnapshotsO0...1object[]definition detail see AAI APIimagesO0...1object[]definition detail see AAI APIavailability-zonesO0...1object[]definition detail see AAI APIrelationship-listO0...1object[]definition detail see AAI API

extra info for Cloud
authInfoItems	M	1

object

[Obj]

Auth information of Cloud

...

authInfoItem:

Attribute	Qualifier

Cardinality

Default	Content	Description

auth-url

cloudDomain

M

1

String

Access urlusername

domain info for keystone v3
userName	M

1

	String	User name
password	M

1

String

Password

default-tenant

authUrl

M

1StringTenant namecloud-domainO0..1StringDomain

		String	authentication url of the cloud, e.g. keystone url
ssl-cacert	O		String	ca file content if enabled ssl on auth-url
ssl-insecure	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

...

Versions Compared

Old Version 31

New Version 32

Key

Update EMS info

VIM

SDN Controller