Table of Contents |
---|
VIM
VIM registration
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vims |
Operation Type | POST |
...
{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one",
"cloudType": "openstack",
"cloudRegionVersion": "v1.0",
"ownerDefinedType": "owner-defined-type",
"cloudZone": "cloud zone",
"complexName": "complex name",
"cloudExtraInfo": "cloud-extra-info",
"vimAuthInfos":
[{
"userName": "admin",
"password": "admin",
"authUrl": "http://10.74.151.13:5000/v2.0",
"sslCacert": "ssl-cacert",
"sslInsecure": true,
"cloudDomain": "cloud-domain"
}]
}
Response:
Success Code: 201200
body:
{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one"
}
Errorcode: 500 Internal Server Error
Update VIM info
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId} |
Operation Type | PUT |
...
{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one",
"cloudType": "openstack",
"cloudRegionVersion": "v1.0",
"ownerDefinedType": "owner-defined-type",
"cloudZone": "cloud zone",
"complexName": "complex name",
"cloudExtraInfo": "cloud-extra-info",
"vimAuthInfos":
[{
"userName": "admin",
"password": "admin",
"authUrl": "http://10.74.151.13:5000/v2.0",
"sslCacert": "ssl-cacert",
"sslInsecure": true,
"cloudDomain": "cloud-domain"
}]
}
Get VIM
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId} |
Operation Type | GET |
...
Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one
Response Parameters:
Get all VIM
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vims |
Operation Type | GET |
...
Response Parameters:
List<VIM>
Delete VIM
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId} |
Operation Type | DELETE |
...
Errorcode: 500 Internal Server Error
VNFM
VNFM registration
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vnfms |
Operation Type | POST |
...
Attribute | Qualifier | Cardinality | Content | Description | |||||
---|---|---|---|---|---|---|---|---|---|
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 |
...
"type":"Tacker", "vimId":"", "vendor":"ZTE", "version":"v1.0", "description":"vnfm", "url":"http://10.74.44.11", "certificateUrl":"", "userName":"admin", "password":"admin" }
...
"vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
}
Success Code: 201200
Errorcode: 500 Internal Server Error
VNFM update
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vnfms/{vnfmId} |
Operation Type | PUT |
...
Attribute | Qualifier | Cardinality | Content | Description | |||||
---|---|---|---|---|---|---|---|---|---|
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 |
...
"type":"Tacker", "vimId":"", "vendor":"ZTE", "version":"v1.0", "description":"vnfm", "url":"http://10.74.44.11", "certificateUrl":"", "userName":"admin", "password":"admin" }
Response:
Success Code: 201200
Errorcode: 500 Internal Server Error
Get VNFM
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vnfms/{vnfmId} |
Operation Type | GET |
...
{ "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", }
Get all VNFM
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vnfms |
Operation Type | GET |
...
[ { "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" } ]
Delete VNFM
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/vnfms/{vnfmId} |
Operation Type | DELETE |
...
Errorcode: 500 Internal Server Error
SDN Controller
SDN Controller registration
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/sdncontrollers |
Operation Type | POST |
...
"sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
}
Success Code: 201200
Errorcode: 500 Internal Server Error
Update SDN Controller info
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/sdncontrollers/{sdnControllerId} |
Operation Type | PUT |
...
"type":"WAN"
}
Response:
Success Code: 201200
Errorcode: 500 Internal Server Error
Get SDN Controller
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/sdncontrollers/{sdnControllerId} |
Operation Type | GET |
...
{ "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" }
Get all SDN Controller
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/sdncontrollers |
Operation Type | GET |
...
[ { "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" } ]
Delete SDN Controller
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/sdncontrollers/{sdnControllerId} |
Operation Type | DELETE |
...
Errorcode: 500 Internal Server Error
EMS
EMS registration
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/emses |
Operation Type | POST |
...
"emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
}
Success Code: 201200
Errorcode: 500 Internal Server Error
Update EMS info
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/emses/{emsId} |
Operation Type | PUT |
...
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
Get EMS by id
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/emses/{emsId} |
Operation Type | GET |
...
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
Get all EMS
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/emses |
Operation Type | GET |
...
"alarmAddr": {
"ip": "10.44.55.145",
"port": 2000,
"user": "root",
"password": "test"
}
}
]
Delete EMS
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/emses/{emsId} |
Operation Type | DELETE |
...
Errorcode: 500 Internal Server Error
PNF
PNF registration
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/pnfs |
Operation Type | POST |
...
"userLabel":"pnf1", "subnetId":"15da65fa1f", "neId":"4f6asd8ff4asd", "managementType":"test", "vendor":"zte", "pnfdId":"8f7adfa8fa9", "emsId":"fdsa5f4afd4a", "lattitude":"156.446", "longitude":"121.154" }
Response:
Success Code: 201200
Errorcode: 500 Internal Server Error
Update PNF info
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/pnfs/{pnfId} |
Operation Type | PUT |
...
"userLabel":"pnf1", "subnetId":"15da65fa1f", "neId":"4f6asd8ff4asd", "managementType":"test", "vendor":"zte", "pnfdId":"8f7adfa8fa9", "emsId":"fdsa5f4afd4a", "lattitude":"156.446", "longitude":"121.154" }
Response:
Success Code: 201200
Errorcode: 500 Internal Server Error
Get PNF by ID
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/pnfs/{pnfId} |
Operation Type | GET |
...
"userLabel":"pnf1", "subnetId":"15da65fa1f", "neId":"4f6asd8ff4asd", "managementType":"test", "vendor":"zte", "pnfdId":"8f7adfa8fa9", "emsId":"fdsa5f4afd4a", "lattitude":"156.446", "longitude":"121.154" }
Get all PNF
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/pnfs |
Operation Type | GET |
...
"userLabel":"pnf1", "subnetId":"15da65fa1f", "neId":"4f6asd8ff4asd", "managementType":"test", "vendor":"zte", "pnfdId":"8f7adfa8fa9", "emsId":"fdsa5f4afd4a", "lattitude":"156.446", "longitude":"121.154" }
]
Delete PNF
Interface Definition | Description |
---|---|
URI | /api/aai-esr-server/v1/pnfs/{pnfId} |
Operation Type | DELETE |
...
Errorcode: 500 Internal Server Error
Information elements
VNFM
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 | 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 | |
vimAuthInfos | M | 1 | [Obj] | Auth information of Cloud |
...
Attribute | Qualifier | Default | 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 | |
defaultTenant | O | String | ||
sslCacert | O | String | ca file content if enabled ssl on auth-url | |
sslInsecure | 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 |
EMS
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
emsId | M | 1 | String | EMS identifier |
name | O | 0..1 | String | EMS name |
vendor | O | 0..1 | String | Vendor |
version | O | 0..1 | String | version |
description | O | 0..1 | String | description |
resourceAddr | O | 0..1 | Obj | Address to get resource data |
performanceAddr | O | 0..1 | Obj | Address to get performance data |
alarmAddr | O | 0..1 | Obj | Address to get alarm data |
resourceAddr
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
ftptype | O | 0..1 | Enum{ftp/sftp} | ftp type |
ip | O | 0..1 | String | service IP of ftp server |
port | O | 0..1 | String | service port of ftp server |
user | O | 0..1 | String | ftp user name |
password | O | 0..1 | String | ftp password |
remotepath | O | 0..1 | String | resource data file path |
passive | O | 0..1 | Boolean | ftp passive mode or not |
performanceAddr
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
ftptype | O | 0..1 | Enum{ftp/sftp} | ftp type |
ip | O | 0..1 | String | service IP of ftp server |
port | O | 0..1 | String | service port of ftp server |
user | O | 0..1 | String | ftp user name |
password | O | 0..1 | String | ftp password |
remotepath | O | 0..1 | String | performance data file path |
passive | O | 0..1 | Boolean | ftp passive mode or not |
alarmAddr
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
ip | O | 0..1 | String | service IP of ftp server |
port | O | 0..1 | String | service port of ftp server |
user | O | 0..1 | String | ftp user name |
password | O | 0..1 | String | ftp password |
PNF
Attribute | Qualifier | Cardinality | Content | Description |
---|---|---|---|---|
pnfId | M | 1 | String | unique ID of PNF |
userLabel | M | 1 | String | PNF system name |
subnetId | M | 1 | String | subnet ID of DU network element |
neId | M | 1 | String | network element ID |
managementType | O | 1 | String | |
vendor | O | 1 | String | |
pnfdId | M | 1 | String | |
emsId | M | 1 | String | |
lattitude | O | 1 | String | |
longitude | O | 1 | String |
...