Versions Compared

Key

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

...

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

...

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

...

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

...

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

...

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

...

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

Response Parameters:
VIM

Response Sample:

   {
       "name":"vim",

...

Response Parameters:
List<VIM>

Response Sample:

   [
       {
           "name":"vim",

...

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

Response Parameters:
VIM

Response Sample:

   {
       "name":"vim",

...

   {
       "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 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":"WAN",
       "createTime":"2016-07-18 12:22:53"
   }

...

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":"WAN",
       "createTime":"2016-07-18 12:22:53"
   }

...

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":"WAN",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

...

   {
       "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":"WAN",
       "createTime":"2016-07-18 12:22:53"
   }

...

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:

/onapapi/aai/esr/v1/emses

...

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

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

...

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

Response Parameters:
EMS

Response Sample:

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

...

Response Parameters:
List<EMS>

Response Sample:

   [

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

...

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier
nameO0..1StringEMS name
vendorO0..1StringVendor
versionO0..1Stringversion
descriptionO0..1Stringdescription
resourceAddrO0..1ObjAddress to get resource data
performanceAddrO0..1ObjAddress to get performance data
alarmAddrO0..1ObjAddress to get alarm data

resourceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeO0..1Enum{ftp/sftp}ftp type
ipO0..1Stringservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1Stringftp password
remotepathO0..1Stringresource data file path
passiveO0..1Booleanftp passive mode or not

performanceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeO0..1Enum{ftp/sftp}ftp type
ipO0..1Stringservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1Stringftp password
remotepathO0..1Stringperformance data file path
passiveO0..1Booleanftp passive mode or not

alarmAddr:

AttributeQualifierCardinalityContentDescription
ipO0..1Stringservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1Stringftp password

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

...

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

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

...

AttributeContentDescription
emsIdStringEMS identifier(UUID)
nameStringEMS name
descriptionStringdescription
versionStringversion
vendorStringVendor
createTimeStringCreate time
productNameStringproduct name
resourceresourceInforesource data access address
performanceperformanceInfoperformance data access address
alarmalarmInfoalarm data access address

resourceAddr:

AttributeContentDescription
ftptypeEnum{ftp/sftp}ftp type
ipStringservice IP of ftp server
portStringservice port of ftp server
userStringftp user name
passwordStringftp password
remotepathStringresource data file path
passiveBooleanftp passive mode or not

performanceAddr:

AttributeContentDescription
ftptypeEnum{ftp/sftp}ftp type
ipStringservice IP of ftp server
portStringservice port of ftp server
userStringftp user name
passwordStringftp password
remotepathStringperformance data file path
passiveBooleanftp passive mode or not

alarmAddr:

AttributeContentDescription
ipStringservice IP of ftp server
portStringservice port of ftp server
userStringftp user name
passwordStringftp password