Versions Compared

Key

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

Table of Contents

...

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
vimAuthInfosM1[Obj]Auth information of Cloud

...

AttributeQualifierDefaultContentDescription
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
vimAuthInfos
M
[Obj]Auth information of Cloud

...

Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one

Response Parameters:

VIM

Get all VIM

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

...

Response Parameters:
List<VIM>

Delete VIM

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}
Operation TypeDELETE

...

AttributeQualifierCardinalityContentDescription
nameM1StringVNFM name
typeM1StringVNFM type
vimIdO0..1StringRelated VIM
vendorM1StringVNFM vendor
versionM1StringVNFM versiondescriptionO
0..1StringVNFM descriptioncertificateUrlO0..1Stringcertificate url
urlM1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword

...

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

...

AttributeQualifierCardinalityContentDescription
nameM1StringVNFM name
typeM1StringVNFM type
vimIdO0..1StringRelated VIM
vendorM1StringVNFM vendor
versionM1StringVNFM versiondescriptionO0..1String
VNFM descriptioncertificateUrlO0..1Stringcertificate url
urlM1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword

...

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

...

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

Response Parameters:
VNFM

Response Sample:

Success Code: 200

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

...

Response Parameters:
List<VNFM>

Response Sample:

Success Code: 200   
 [
       {
           "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"
       }
   ]

...

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

Response Parameters:
SDN Controller

Response Sample:

Success Code: 200

...

Response Parameters:
List<SDN Controller>

Response Sample:

Success Code: 200  

...

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

Response Parameters:
EMS

Response Sample:

{

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

...

Response Parameters:
List<EMS>

Response Sample:

Success Code: 200

...

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

Response Parameters:
PNF

Response Sample:

Success Code: 200

...

Response Parameters:
List<PNF>

Response Sample:

Success Code: 200   

...

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

...

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
vimAuthInfosM1[Obj]Auth information of Cloud

...