Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AttributeQualifierDefaultContentDescription
cloudOwnerM
Stringcloud owner name, can be customized, e.g. att-aic
cloudRegionIdM
Stringcloud region info based on deployment, e.g. RegionOne
cloudTypeM
Stringtype of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersionM
Stringcloud version, ocata, mitaka or other
ownerDefinedTypeO
StringCloud-owner defined type indicator (e.g., dcp, lcp)
cloudZoneO
StringZone where the cloud is homed.
complexNameO
Stringcomplex name for cloud-region instance.
cloudExtraInfoO
Stringextra info for Cloud
authInfoItemsM1[Obj]Auth information of Cloud

authInfoItem:

AttributeQualifierDefaultContentDescription
cloudDomainM
Stringdomain info for keystone v3
userNameM
StringUser name
passwordM
StringPassword
authUrlM
Stringauthentication url of the cloud, e.g. keystone url
ssl-cacertO
Stringca file content if enabled ssl on auth-url
ssl-insecureO
BooleanWhether to verify VIM's certificate

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

...

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses
Operation TypePOST

Request Parameters:

...

Errorcode: 500 Internal Server Error

Update EMS info

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses/{emsId}
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
nameM1StringEMS name
vendorM1Stringvendor
versionM1Stringversion
descriptionO0..1Stringdescription
resourceAddrM1ObjAddress to get resource data
performanceAddrM1ObjAddress to get performance data
alarmAddrM1ObjAddress to get alarm data

resourceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeM1Enum{ftp/sftp}ftp type
ipM1Stringservice IP of ftp server
portM1Stringservice port of ftp server
userM1Stringftp user name
passwordM1Stringftp password
remotepathM1Stringresource data file path
passiveM1Booleanftp passive mode or not

performanceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeM1Enum{ftp/sftp}ftp type
ipM1Stringservice IP of ftp server
portM1Stringservice port of ftp server
userM1Stringftp user name
passwordM1Stringftp password
remotepathM1Stringperformance data file path
passiveM1Booleanftp passive mode or not

alarmAddr:

AttributeQualifierCardinalityContentDescription
ipM1Stringservice IP of ftp server
portM1Stringservice port of ftp server
userM1Stringftp user name
passwordM1Stringftp password

Request Sample:

/api/aai-esr-server/v1/emses

...

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses
Operation TypeGET

Request Parameters:
N/A

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

Response Parameters:
List<EMS>

...

AttributeQualifierCardinalityContentDescription
vnfmIdO0..1StringVNFM UUID generated by ESR
nameM1StringVNFM name
typeM1StringVNFM type
vimIdO0..1StringRelated VIM
vendorM1StringVNFM vendor
versionM1StringVNFM version
descriptionO0..1StringVNFM description
certificateUrlO0..1Stringcertificate url
urlM1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword

VIM

AttributeQualifier
Cardinality
DefaultContentDescription
cloud-owner
cloudOwnerM
1

String
Cloud ownercloud-region-id
cloud owner name, can be customized, e.g. att-aic
cloudRegionIdM
1

String
Cloud
cloud region
cloud-extra-info
O0...1StringExtra information of Cloudcloud-typeO0...1StringType of the cloud (e.g., openstack)owner-defined-typeO0...1
info based on deployment, e.g. RegionOne
cloudTypeM
Stringtype of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersionM
Stringcloud version, ocata, mitaka or other
ownerDefinedTypeO
StringCloud-owner defined type indicator
cloud-region-version
(e.g., dcp, lcp)
cloudZoneO
0...1

String
Software version employed at the siteidentity-url
Zone where the cloud is homed.
complexNameO
0...1StringURL of the keystone identity servicecloud-zoneO0...1StringZone where the cloud is homedcomplex-nameO0...1Stringcomplex name for cloud-region instanceresource-versionO0...1StringUsed 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[]

Stringcomplex name for cloud-region instance.
cloudExtraInfoO
Stringextra info for Cloud
definition detail see AAI API
authInfoItemsM1
object
[Obj]Auth information of Cloud

...

authInfoItem:

AttributeQualifier
Cardinality
DefaultContentDescription
auth-url
cloudDomainM
1

String
Access urlusername
domain info for keystone v3
userNameM
1

StringUser name
passwordM
1

StringPassword
default-tenant
authUrlM
1StringTenant namecloud-domainO0..1StringDomain

Stringauthentication url of the cloud, e.g. keystone url
ssl-cacertO
Stringca file content if enabled ssl on auth-url
ssl-insecureO
BooleanWhether to verify VIM's certificate


SDN Controller

AttributeQualifierCardinalityContentDescription

sdnControllerId

M1StringUUID of sdncontroller
nameM1StringSDN Controller name
locationO1Stringfit for DC type
urlM1StringAccess url
vendorM1StringSDNC vendor
versionM1StringSDNC version
descriptionO0..1StringSDNC description
productNameO0..1StringSDNC productName
protocolM1Enum{netconf/snmp}protocol
userNameM1StringUser name
passwordM1StringPassword
typeM1Enum{WAN/DC}SDN Controller type

...