This API is only exposed to esr portal.
| Table of Contents |
|---|
VIM
VIM registration
...
| 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 |
|---|---|---|---|---|
| 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 | [Obj] | Auth information of Cloud |
...
Errorcode: 500 Internal Server Error
PNF
PNF registration
Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/pnfs |
| Operation Type | POST |
Request Parameters:
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 |
Request Sample:
/api/aai-esr-server/v1/pnfs
...
Errorcode: 500 Internal Server Error
Update PNF info
Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/pnfs/{pnfId} |
| Operation Type | PUT |
Request Parameters:
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 |
Body:Request Sample:
/api/aai-esr-server/v1/pnfs/dafdaf3213dfa
...
Errorcode: 500 Internal Server Error
Get PNF by ID
Interface Definition | Description |
|---|---|
| URI | /api/aai-esr-server/v1/pnfs/{pnfId} |
| Operation Type | GET |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| pnfId | M | 1 | String | PNF identifier |
Request Sample:
/api/aai-esr-server/v1/pnfs/dafdaf3213dfa
...
"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 |
Request Parameters:
N/A
Request Sample:
/api/aai-esr-server/v1/pnfs
...
"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 |
Request Parameters:
Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| pnfId | M | 1 | String | PNF identifier |
Request Sample:
/api/aai-esr-server/v1/pnfs/dafdaf3213dfa
...
| 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 | 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 |