Versions Compared

Key

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

This API is only exposed to esr portal.

Table of Contents

VIM

VIM registration

...

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

...

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

...

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

...

       "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

...

       "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

...

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