Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 25

VNFM

VNFM registration

Interface DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/vnfms
Operation TypePOST

Request Parameters:

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

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/vnfms/{vnfmId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
vnfmIdM1StringVNFM identifier

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/vnfms
Operation TypeGET

Request Parameters:
N/A

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/vnfms/{vnfmId}
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
vnfmIdM1StringVNFM identifier
nameO0..1StringVNFM name
vendorO0..1StringVNFM vendor
urlO0..1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/vnfms/{vnfmId}
Operation TypeDELETE

Request Parameters:

AttributeQualifierCardinalityContentDescription
vnfmIdM1StringVNFM identifier

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

Response Parameters:
N/A

Response Sample:
N/A

 

VIM

VIM registration

Interface DefinitionDescription
URI/
onapapi
openoapi/
aai
extsys/
esr/
v1/vims
Operation TypePOST

Request Parameters:

AttributeQualifierCardinalityContentDescription
nameM1StringVIM name
urlM1StringAccess url
userNameM1StringUser name
passwordM1StringPassword
tenantM1StringTenant name
domainO0..1StringDomain
vendorM1StringVIM vendor
versionM1StringVIM version
descriptionO0..1StringVIM description
typeM1Enum{openstack/vmware}VIM type

Request Sample:
/onapapiopenoapi/aaiextsys/esr/v1/vims

   {
       "name":"vim",
       "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:

   {
       "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":"v1.0",
       "description":"",
       "domain":"",
       "type":"openstack",
       "createTime":"2016-07-18 12:22:53"
   }

Get VIM by id

Interface DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/vims/{vimId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
vimIdM1StringVIM identifier

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

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":"v1.0",
       "description":"",
       "domain":"",
       "type":"openstack",
       "createTime":"2016-07-18 12:22:53"
   }

Get all VIM

Interface DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/vims
Operation TypeGET

Request Parameters:
N/A

Request Sample:
/onapapiopenoapi/aaiextsys/esr/v1/vims

Response Parameters:
List<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":"v1.0",
           "description":"",
           "domain":"",
           "type":"openstack",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

Update VIM

Interface DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/vims/{vimId}
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
vimIdM1StringVIM identifier
nameO0..1StringVIM name
urlO0..1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword
tenantO0..1StringTenant name
domainO0..1StringDomain
vendorO0..1StringVIM vendor

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

   {
       "vimId":"57674786-5b2e-4c92-bb68-578dbd79e2f5",
       "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:

   {
       "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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/vims/{vimId}
Operation TypeDELETE

Request Parameters:

AttributeQualifierCardinalityContentDescription
vimIdM1StringVIM identifier

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

Response Parameters:
N/A

Response Sample:
N/A

SDN Controller

SDN Controller registration

Interface DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/sdncontrollers
Operation TypePOST

Request Parameters:

AttributeQualifierCardinalityContentDescription
nameM1StringSDN Controller name
urlM1StringAccess url
vendorM1StringSDNC vendor
versionM1StringSDNC version
descriptionO0..1StringSDNC description
productNameO0..1StringSDNC productName
protocolM1Enum{netconf/snmp}protocol
userNameM1StringUser name
passwordM1StringPassword
typeM1Enum{ODL/ONOS}SDN Controller type

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/sdncontrollers/{sdnControllerId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
sdnControllerIdM1StringSDN Controller identifier

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/sdncontrollers
Operation TypeGET

Request Parameters:
N/A

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/sdncontrollers/{sdnControllerId}
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
sdnControllerIdM1StringSDN Controller identifier
nameO0..1StringSDN Controller name
urlO0..1StringAccess url
vendorO0..1StringSDNC vendor
versionO0..1StringSDNC version
descriptionO0..1StringSDNC description
productNameO0..1StringSDNC productName
protocolO0..1Enum{netconf/snmp}protocol
userNameO0..1StringUser name
passwordO0..1StringPassword

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/sdncontrollers/{sdnControllerId}
Operation TypeDELETE

Request Parameters:

AttributeQualifierCardinalityContentDescription
sdnControllerIdM1StringSDN Controller identifier

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

Response Parameters:
N/A

Response Sample:
N/A

EMS

EMS registration

Interface DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/emses
Operation TypePOST

Request Parameters:

AttributeQualifierCardinalityContentDescription
nameM1StringEMS name
vendorM1Stringvendor
versionM1Stringversion
descriptionO0..1Stringdescription
productNameO0..1StringproductName
urlM1StringAccess url
userNameM1StringUser name
passwordM1StringPassword

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/emses/{emsId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/emss
Operation TypeGET

Request Parameters:
N/A

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/emses/{emsId}
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier
nameO0..1StringEMS name
vendorO0..1StringVendor
versionO0..1Stringversion
descriptionO0..1Stringdescription
productNameO0..1StringproductName
urlO0..1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword

Request Sample:
/onapapiopenoapi/aaiextsys/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 DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/emses/{emsId}
Operation TypeDELETE

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier

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

Response Parameters:
N/A

Response Sample:
N/A

Other

Get basic info by id

Interface DefinitionDescription
URI/onapapiopenoapi/aaiextsys/esr/v1/common/{instanceId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
instanceIdM1StringExternal system identifier

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

Response Parameters:

AttributeContentDescription
instanceIdStringExternal system identifier(UUID)
categoryEnum{VIM/VNFM/SDNC/EMS}External system category
nameStringExternal system name
descriptionStringExternal system description
versionStringExternal system version
vendorStringExternal system vendor
typeStringExternal system type
createTimeStringCreate 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

AttributeContentDescription
vnfmIdStringVNFM identifier(UUID)
nameStringVNFM name
descriptionStringVNFM description
versionStringVNFM version
vendorStringVNFM vendor
typeStringVNFM type
urlStringAccess url
userNameStringUser name
passwordStringPassword
createTimeStringCreate time
vimIdStringRelated VIM
certificateUrlStringVNFM certificate url

VIM

AttributeContentDescription
vimIdStringVIM identifier(UUID)
nameStringVIM name
descriptionStringVIM description
versionStringVIM version
vendorStringVIM vendor
typeEnum{openstack/vmware}VIM type
urlStringAccess url
userNameStringUser name
passwordStringPassword
createTimeStringCreate time
tenantStringTenant name
domainStringVIM domain

SDN Controller

AttributeContentDescription
sdnControllerId(UUID)StringSDN Controller identifier
nameStringSDN Controller name
descriptionStringdescription
versionStringversion
vendorStringvendor
typeEnum{ODL/ONOS}SDN Controller type
urlStringAccess url
userNameStringUser name
passwordStringPassword
createTimeStringCreate time
protocolEnum{netconf/snmp}protocol
productNameStringproductName

EMS

AttributeContentDescription
emsIdStringEMS identifier(UUID)
nameStringEMS name
descriptionStringdescription
versionStringversion
vendorStringVendor
urlStringAccess url
userNameStringUser name
passwordStringPassword
createTimeStringCreate time
productNameStringproduct name