5 About Optical FTP Discovery Input File Structure
For Optical Devices FTP scan to work, the files must be populated with the corresponding value.
Table 5-1 List of Supported Files
| File Name | Mandatory | Description |
|---|---|---|
NE_REPORT_FILE |
YES | This file contains NetworkElement information |
SUBRACK_REPORT_FILE_NAME |
YES | This file contains Sub_Rack (Equipment Chassis) information |
BOARD_REPORT_FILE |
YES | This file contains Card related information present under Sub_Rack |
PORT_REPORT_FILE |
YES | This file contains port Information |
PHYSICAL_LOCATION_FILE |
YES | This file contains Physical Location details of NetworkElement |
| Interface_Resource_Report_File | YES | This file contains Device Interface details and Mapping between PhysicalPort Informations |
Note:
File naming convention can be changed by making the necessary changes inside opticalfiles.properties located at Optical_FTP_Discovery_Cartridge/src. Each file is structured with a predetermined set of columns, each containing essential device information.
In each file, the initial seven lines are reserved for report-related information and are not utilized. The eighth line serves as the actual header, defining the columns. The subsequent lines contain the specific details pertaining to each device
NE Report File
The following table shows the list of column headers required within the file.
Table 5-2 NE Report File
| Header Name | Essential (Data) | Description |
|---|---|---|
| NE Name | YES | Network Element name |
| NE Type | YES | Type of Device Model |
| NE ID | YES | Unique Id that represent Network Element |
| Subrack Type | YES | Subrack Type |
| Software Version | NO | Software Version been used by the device |
Sub_Rack Report File
The following table shows the list of column headers required within the file
Table 5-3 Sub_Rack Report File
| Header Name | Essential (Data) | Description |
|---|---|---|
| NE | YES | Network Element under which this rack is present |
| Subrack Name | YES | Rack name |
| Subrack Type | YES | Type of Rack |
| Subrack ID | YES | Unique Id to represent Rack |
| Software Version | NO | Rack Software |
| SN(Bar Code) | NO | Bar Code Information |
| Description | NO | Rack Description |
| Subnet | NO | Subnet Related information |
| Subnet Path | NO | Subnet Path Information |
Board Report File
The following table shows the list of column headers required within the file.
Table 5-4 Board Report File
| Header Name | Essential (Data) | Description |
|---|---|---|
| NE | YES | Network Element under which this board is present |
| NE Type | YES | Network Element Type |
| Board Name | YES | Board Name |
| Board Type | YES | Board Type |
| Subrack ID | YES | Rack (Id)under which this board is present |
| Slot ID | YES | Container (Id) that hold this board |
| Hardware Version | NO | Board Hardware Version |
| SN(Bar Code) | NO | Board SN(Bar Code) |
| Serial Number | NO | Board Serial Number |
| Software Version | NO | Board Software Version |
| Description | NO | Board Description |
Physical_Location File
The following table shows the list of column headers required within the file.
Table 5-5 Physical_Location File
| Header Name | Essential (Data) | Description |
|---|---|---|
| NE Name | YES | Network Element name |
| Location | YES | Physical Location |
Physical Location Report Sample File
Interface_Resource_Report File
The following table shows the list of column headers required within the file.
Table 5-6 Interface_Resource_Report File
| Header Name | Essential (Data) | Description |
|---|---|---|
| Interface Name | YES | Interface Name |
| NE Name | YES | Network Element name |
| Interface Description | NO | Interface Description |
| Ipv4Address | NO | IPV4 Address |
| Ipv6Adress | NO | IPV6 Address |
| Interface Type | NO | Interface Type |
| Speed | NO | Interface Supported Speed |
| Status | NO |
Interface Status Supported Value.(UP /DOWN) |
| MtuCurrent | NO | Interface MtuCurrent Details |
| Port Mapping | NO |
Interface-PhysicalPort Mapping details Supported Value Format:
|