VIM

VIM registration

Interface DefinitionDescription
URI

/api/aai-esr-server/v1/vims

Operation TypePOST

Request Body:

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

authInfoItem:

AttributeQualifierDefaultContentDescription
cloudDomainM
Stringdomain info for keystone v3
userNameM
StringUser name
passwordM
StringPassword
authUrlM
Stringauthentication url of the cloud, e.g. keystone url
sslCacertO
Stringca file content if enabled ssl on auth-url
sslInsecureO
BooleanWhether to verify VIM's certificate

Request Sample:
/api/aai-esr-server/v1/vims

Body:

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

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 TypePUT

Request Body:

   

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

authInfoItem:

AttributeQualifierDefaultContentDescription
cloudDomainM
Stringdomain info for keystone v3
userNameM
StringUser name
passwordM
StringPassword
authUrlM
Stringauthentication url of the cloud, e.g. keystone url
sslCacert
O
Stringca file content if enabled ssl on auth-url
sslInsecureO
BooleanWhether to verify VIM's certificate


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

{
"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 DefinitionDescription
URI

/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}

Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
cloudOwnerM1StringCloud owner
cloudRegionIdM1StringCloud region

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

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/vims

Response Parameters:
List<VIM>

Delete VIM

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

Request Parameters:

AttributeQualifierCardinalityContentDescription
vimIdM1StringVIM identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

VNFM

VNFM registration

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vnfms
Operation TypePOST

Request Parameters:

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

Request Sample:
/api/aai-esr-server/v1/vnfms

Body:

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

Response:

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

}

Success Code: 200

Errorcode: 500 Internal Server Error

VNFM update

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vnfms/{vnfmId}
Operation TypePUT

Request Parameters:

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

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

Body:

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

Response:

Success Code: 200

Errorcode: 500 Internal Server Error


Get VNFM

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vnfms/{vnfmId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
vnfmIdM1StringVNFM identifier

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",
       "certificateUrl":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
   }

Get all VNFM

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

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/vnfms

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",
           "certificateUrl":"",
           "url":"http://10.74.44.11",
           "userName":"admin",
           "password":"admin"
       }
   ]

Delete VNFM

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vnfms/{vnfmId}
Operation TypeDELETE

Request Parameters:

AttributeQualifierCardinalityContentDescription
vnfmIdM1StringVNFM identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration 

Interface DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers
Operation TypePOST

Request Parameters:

AttributeQualifierCardinalityContentDescription

sdnControllerId

M1StringUUID of sdncontroller
nameM1StringSDN Controller name
locationO1Stringfit for DC type
urlM1StringAccess url
vendorM1StringSDNC vendor
versionM1StringSDNC version
descriptionO0..1StringSDNC description
productNameO0..1StringSDNC productName
protocolM1Stringprotocol, such as netconf/snmp
userNameM1StringUser name
passwordM1StringPassword
typeM1Enum{WAN/DC}SDN Controller type

Request Sample:
/api/aai-esr-server/v1/sdncontrollers

Body:

{

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

body:

{

"sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",

}

Success Code: 200

Errorcode: 500 Internal Server Error

Update SDN Controller info

Interface DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription

sdnControllerId

M1StringUUID of sdncontroller
nameM1StringSDN Controller name
locationO1Stringfit for DC type
urlM1StringAccess url
vendorM1StringSDNC vendor
versionM1StringSDNC version
descriptionO0..1StringSDNC description
productNameO0..1StringSDNC productName
protocolM1Stringprotocol, such as netconf/snmp
userNameM1StringUser name
passwordM1StringPassword
typeM1Enum{WAN/DC}SDN Controller type

Request Sample:
/api/aai-esr-server/v1/sdncontrollers/a6c42529-cd6b-4c01-b149-03eb54b20a03

Body:

{

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

Success Code: 200

Errorcode: 500 Internal Server Error

Get SDN Controller

Interface DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
sdnControllerIdM1StringSDN Controller identifier

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

Response Parameters:
SDN Controller

Response Sample:

Success Code: 200

   {
       "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 DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers
Operation TypeGET

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/sdncontrollers

Response Parameters:
List<SDN Controller>

Response Sample:

Success Code: 200  
 [
       {
           "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 DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation TypeDELETE

Request Parameters:

AttributeQualifierCardinalityContentDescription
sdnControllerIdM1StringSDN Controller identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error


EMS

EMS registration 

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses
Operation TypePOST

Request Parameters:

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:

/api/aai-esr-server/v1/emses

Body:

{

"emsName": "EMS_TEST",

"version":"v1.0",

"vendor":"ZTE",

"description":"",

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

body:

{

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

}

Success Code: 200

Errorcode: 500 Internal Server Error

Update EMS info

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses/{emsId}
Operation TypePUT

Request Parameters:

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:

/api/aai-esr-server/v1/emses

Body:

{

"emsName": "EMS_TEST",

"version":"v1.0",

"vendor":"ZTE",

"description":"",

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

}

}


Get EMS by id

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses/{emsId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier

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

Response Parameters:
EMS

Response Sample:

{

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

"emsName": "EMS_TEST",

"version":"v1.0",

"vendor":"ZTE",

"description":"",

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

}

}

Get all EMS

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

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/emses

Response Parameters:
List<EMS>

Response Sample:

Success Code: 200

[

{

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

"emsName": "EMS_TEST",

"version":"v1.0",

"vendor":"ZTE",

"description":"",

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

}

}

]

Delete EMS

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses/{emsId}
Operation TypeDELETE

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error


PNF

PNF registration

Interface Definition

Description

URI/api/aai-esr-server/v1/pnfs
Operation TypePOST

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

pnfIdM1Stringunique ID of PNF
userLabelM1StringPNF system name
subnetIdM1Stringsubnet ID of DU network element
neIdM1Stringnetwork element ID
managementTypeO1String
vendorO1String
pnfdIdM1String
emsIdM1String
lattitudeO1String
longitudeO1String

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

Body:

   {
       "pnfId":"dafdaf3213dfa",
       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }

Response:


Success Code: 200

Errorcode: 500 Internal Server Error

Update PNF info

Interface Definition

Description

URI/api/aai-esr-server/v1/pnfs/{pnfId}
Operation TypePUT

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

pnfIdM1Stringunique ID of PNF
userLabelM1StringPNF system name
subnetIdM1Stringsubnet ID of DU network element
neIdM1Stringnetwork element ID
managementTypeO1String
vendorO1String
pnfdIdM1String
emsIdM1String
lattitudeO1String
longitudeO1String


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

   {
       "pnfId":"dafdaf3213dfa",
       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }

Response:

Success Code: 200

Errorcode: 500 Internal Server Error

Get PNF by ID

Interface Definition

Description

URI/api/aai-esr-server/v1/pnfs/{pnfId}
Operation TypeGET

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

pnfIdM1StringPNF identifier

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

Response Parameters:
PNF

Response Sample:

Success Code: 200

   {
       "pnfId":"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 TypeGET

Request Parameters:
N/A

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

Response Parameters:
List<PNF>

Response Sample:

Success Code: 200   
 [
   {
       "pnfId":"dafdaf3213dfa",
       "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 TypeDELETE

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

pnfIdM1StringPNF identifier

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

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

Information elements

VNFM

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

VIM

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

vimAuthInfo:

AttributeQualifierDefaultContentDescription
cloudDomainM
Stringdomain info for keystone v3
userNameM
StringUser name
passwordM
StringPassword
authUrlM
Stringauthentication url of the cloud, e.g. keystone url
defaultTenantO
String
sslCacertO
Stringca file content if enabled ssl on auth-url
sslInsecureO
BooleanWhether to verify VIM's certificate


SDN Controller

AttributeQualifierCardinalityContentDescription

sdnControllerId

M1StringUUID of sdncontroller
nameM1StringSDN Controller name
locationO1Stringfit for DC type
urlM1StringAccess url
vendorM1StringSDNC vendor
versionM1StringSDNC version
descriptionO0..1StringSDNC description
productNameO0..1StringSDNC productName
protocolM1Enum{netconf/snmp}protocol
userNameM1StringUser name
passwordM1StringPassword
typeM1Enum{WAN/DC}SDN Controller type

EMS

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


PNF

Attribute

Qualifier

Cardinality

Content

Description

pnfIdM1Stringunique ID of PNF
userLabelM1StringPNF system name
subnetIdM1Stringsubnet ID of DU network element
neIdM1Stringnetwork element ID
managementTypeO1String
vendorO1String
pnfdIdM1String
emsIdM1String
lattitudeO1String
longitudeO1String



  • No labels

3 Comments

  1. Vlademir Brusse

    Hello,

    As all other updates are PUT operation, can you please, confirm if VNFM Update is a POST operation ?

    Thanks.

  2. xing xiaocheng

    Hello Zi Li:

    Do we have APIs for PNF in ESR project?

    Can we import existing VNF/PNF to AAI through ESR portal?

  3. Ronan Kenny

    I have updated the VNFM section to remove the "description" field from the POST and PUT json samples. I also removed it from the GET response samples. This is based on the ONAP ESR Service rest API.

    /Ronan