6 About IMS Network FTP Input File Structure
For IMS Network FTP scan to work properly, files must be populated with proper value.
Table 6-1 shows the list of supported files:
Table 6-1 List of Supported Files
| FileName | Mandatory | Description |
|---|---|---|
| NE_Information_File | Yes | This file contains NetworkElement information. |
| Shelf_Information_File | Yes | This file contains shelf (equipment) information. |
| Board_Information_File | Yes | This file contains cards (equipment) information. |
| Frame_Information_File | Yes | This file contains frame related information. |
| Model_Information_File | Yes | This file contains module information. |
| Port_Information_File | Yes | This file contains physical port related information. |
Note:
-
File naming convention can be changed by making necessary changes inside imsnetworkfiles.properties located at IMS_Discovery_Cartridge/src
-
Each file is structured with a predetermined set of columns, each containing essential device information. Each file contains metadata at the start and the results of the report begins from the eighth line. Subsequent lines contain the specific details pertaining to each device.
NE Report File
Table 6-2 shows the list of column headers required within the file:
Table 6-2 List of Column Headers
| Header Name | Description |
|---|---|
| SoftX3000 Name | Network element name |
| IP Address | IP address of the element |
| Result | Result of the element |
Sample NE Report File
+++ HW-UMS 2023-08-25 08:19:06-07:00 DST
O&M #256676
%%DSP PATCH:;%%
RETCODE = 0 Network Management Operation Succeed
Opration Summary
-----------------------------
Name IP Address Result
Sample1 5.0.0.1 Success
(Result number = 1)
--- ENDShelf Report File
Table 6-3 shows the list of column headers required within the file:
Table 6-3 List of Column Headers
| Header Name | Description |
|---|---|
| Frame number | Id of the shelf (ranges from 0 to n-1 for n number of shelves) |
| Shelf number | Shelf number |
| Position number | Position number of shelf |
Sample Shelf Report File
+++ LOCAL 2023-08-25 10:25:56-15:00 DST
O&M #8435619
%%LST FRM:;%%
RETCODE = 0 Operation succeeded
Frame information
-----------------
Frame number Shelf number Position number
0 0 2
1 0 3
2 1 0
3 1 1
4 1 2
5 1 3
6 2 0
7 2 1
8 2 2
9 2 3
(Number of results = 10)
--- ENDFrame Report File
This file contains sections for each frame available in Shelf report file. Each section contains details about slots of that particular frame.
Table 6-4 shows the list of column headers required within the file:
Table 6-4 List of Column Headers
| Header Name | Description |
|---|---|
| Frame | ID of the frame. |
| Slot | ID of the slot. |
| FrontBrd | Front board |
| FrontBrdState | State of front board |
| UpperPMC | Upper PMC |
| LowerPMC | Lower PMC |
| BackBrd | Back board |
| BackBrdState | State of back board |
Sample Frame Report File
+++ LOCAL 2023-08-25 10:25:56-15:00 DST
O&M #8435619
%%DSP FRM:;%%
RETCODE = 0 Operation succeeded
Frame 0 Information
-------------------
Frame Slot FrontBrd FrontBrdState UpperPMC LowerPMC BackBrd BackBrdState
0 0 IFMI Standby ok Uninstalled Uninstalled BFII Normal
0 1 IFMI Main ok Uninstalled Uninstalled BFII Normal
0 2 FCCU Standby ok Uninstalled Uninstalled NULL Uninstalled
0 3 FCCU Main ok Uninstalled Uninstalled NULL Uninstalled
0 4 FCCU Standby ok Uninstalled Uninstalled NULL Uninstalled
0 5 FCCU Main ok Uninstalled Uninstalled NULL Uninstalled
0 6 SMUI Main ok Uninstalled Uninstalled SIUI Main ok
0 7 NULL Uninstalled Uninstalled Uninstalled HSCI Normal
0 8 SMUI Standby ok Uninstalled Uninstalled SIUI Standby ok
0 9 NULL Uninstalled Uninstalled Uninstalled HSCI Normal
0 10 BSGI Standby ok Uninstalled Uninstalled NULL Uninstalled
0 11 BSGI Main ok Uninstalled Uninstalled NULL Uninstalled
0 12 CDBI Standby ok Uninstalled Uninstalled NULL Uninstalled
0 13 CDBI Main ok Uninstalled Uninstalled NULL Uninstalled
0 14 MSGI Standby ok Uninstalled Uninstalled NULL Uninstalled
0 15 MSGI Main ok Uninstalled Uninstalled NULL Uninstalled
0 16 ALUI Normal Uninstalled Uninstalled NULL Uninstalled
0 17~18 UPWR Normal Uninstalled Uninstalled UPWR Normal
0 19~20 UPWR Normal Uninstalled Uninstalled UPWR Normal
Frame 1 Information
-------------------
Frame Slot FrontBrd FrontBrdState UpperPMC LowerPMC BackBrd BackBrdState
1 0 CDBI Main ok Uninstalled Uninstalled NULL Uninstalled
1 1 CDBI Standby ok Uninstalled Uninstalled NULL Uninstalled
1 2 FCCU Standby ok Uninstalled Uninstalled NULL Uninstalled
1 3 FCCU Main ok Uninstalled Uninstalled NULL Uninstalled
1 4 FCCU Main ok Uninstalled Uninstalled NULL Uninstalled
1 5 FCCU Standby ok Uninstalled Uninstalled NULL Uninstalled
1 6 SMUI Standby ok Uninstalled Uninstalled SIUI Standby ok
1 7 NULL Uninstalled Uninstalled Uninstalled HSCI Normal
1 8 SMUI Main ok Uninstalled Uninstalled SIUI Main ok
1 9 NULL Uninstalled Uninstalled Uninstalled HSCI Normal
1 10 MSGI Main ok Uninstalled Uninstalled NULL Uninstalled
1 11 MSGI Main ok Uninstalled Uninstalled NULL Uninstalled
1 12 MSGI Main ok Uninstalled Uninstalled NULL Uninstalled
1 13 MSGI Main ok Uninstalled Uninstalled NULL Uninstalled
1 14 BSGI Main ok Uninstalled Uninstalled NULL Uninstalled
1 15 BSGI Standby ok Uninstalled Uninstalled NULL Uninstalled
1 16 ALUI Normal Uninstalled Uninstalled NULL Uninstalled
1 17~18 UPWR Normal Uninstalled Uninstalled UPWR Normal
1 19~20 UPWR Normal Uninstalled Uninstalled UPWR NormalBoard Report File
Table 6-5 shows the list of column headers required within the file:
Table 6-5 List of Column Headers
| Header Name | Description |
|---|---|
| Frame number | ID of the frame. |
| Slot number | ID of the slot. |
| Location | Location of slot. |
| Board type | Type of board. |
| Module number | Module number |
| Assistant slot number | Assistant slot number |
Sample Board Report File
+++ LOCAL 2023-08-25 10:25:56-15:00 DST
O&M #8435619
%%LST BRD:;%%
RETCODE = 0 Operation succeeded
Board information
-----------------
Frame number Slot number Location Board type Module number Assistant slot number
0 0 Front IFMI 132 1
0 0 Back BFII Invalid Invalid
0 1 Front IFMI 132 0
0 1 Back BFII Invalid Invalid
0 2 Front FCCU 22 3
0 3 Front FCCU 22 2
0 4 Front FCCU 23 5
0 5 Front FCCU 23 4
0 6 Front SMUI 2 8
0 6 Back SIUI Invalid Invalid
0 7 Back HSCI Invalid Invalid
0 8 Front SMUI 2 6
0 8 Back SIUI Invalid Invalid
0 9 Back HSCI Invalid Invalid
0 10 Front BSGI 136 11
0 11 Front BSGI 136 10
0 12 Front CDBI 102 13
0 13 Front CDBI 102 12
0 14 Front MSGI 211 15
0 15 Front MSGI 211 14
0 16 Front ALUI Invalid Invalid
0 17 Front UPWR Invalid Invalid
0 17 Back UPWR Invalid Invalid
0 19 Front UPWR Invalid Invalid
0 19 Back UPWR Invalid Invalid
1 0 Front CDBI 103 1
1 1 Front CDBI 103 0
1 2 Front FCCU 24 3
1 3 Front FCCU 24 2
1 4 Front FCCU 25 5
1 5 Front FCCU 25 4
1 6 Front SMUI 3 8
1 6 Back SIUI Invalid Invalid
1 7 Back HSCI Invalid Invalid
1 8 Front SMUI 3 6
1 8 Back SIUI Invalid Invalid
1 9 Back HSCI Invalid Invalid
1 10 Front MSGI 210 Invalid
1 11 Front MSGI 207 Invalid
1 12 Front MSGI 206 Invalid
1 13 Front MSGI 209 Invalid
1 14 Front BSGI 137 15
1 15 Front BSGI 137 14
1 16 Front ALUI Invalid Invalid
1 17 Front UPWR Invalid Invalid
1 17 Back UPWR Invalid Invalid
1 19 Front UPWR Invalid Invalid
1 19 Back UPWR Invalid InvalidModule Report File
Table 6-6 shows the list of column headers required within the file:
Table 6-6 List of Column Headers
| Header Name | Description |
|---|---|
| Module No. | Module number |
| Module type | Type of module |
| Software type | Type of software |
| Version | Version |
| Patch unit | Number of patch units |
| Unit in activated state | Number of units in activated state |
| Unit in confirmed state | Number of units in confirmed state |
Sample Module Report File
+++ LOCAL 2023-08-25 10:25:56-15:00 DST
O&M #8435619
%%DSP PATCH:;%%
RETCODE = 0 Operation succeeded
Display patch information
-------------------------
Module No. Module type Software type Version Patch unit Unit in activated state Unit in confirmed state
2 Main SMUI V11 67 0 67
3 Main SMUI V11 67 0 67
4 Main SMUI V11 67 0 67
5 Main SMUI V11 67 0 67
6 Main FCCU V11 67 0 67
7 Main FCCU V11 67 0 67
8 Main FCCU V11 67 0 67
9 Main SMUI V300R010C05SPH172 67 0 67
10 Main SMUI V300R010C05SPH172 67 0 67
11 Main SMUI V300R010C05SPH172 67 0 67
22 Main FCCU V300R010C05SPH172 343 0 343
23 Main FCCU V300R010C05SPH172 343 0 343
24 Main FCCU V300R010C05SPH172 343 0 343
25 Main FCCU V300R010C05SPH172 343 0 343
26 Main FCCU V300R010C05SPH172 343 0 343
27 Main FCCU V300R010C05SPH172 343 0 343
28 Main FCCU V300R010C05SPH172 343 0 343
29 Main FCCU V300R010C05SPH172 343 0 343
30 Main FCCU V300R010C05SPH172 343 0 343
31 Main FCCU V300R010C05SPH172 343 0 343
32 Main FCCU V300R010C05SPH172 343 0 343
33 Main FCCU V300R010C05SPH172 343 0 343
34 Main FCCU V300R010C05SPH172 343 0 343
35 Main FCCU V300R010C05SPH172 343 0 343
36 Main FCCU V300R010C05SPH172 343 0 343
37 Main FCCU V300R010C05SPH172 343 0 343
38 Main FCCU V300R010C05SPH172 343 0 343
39 Main FCCU V300R010C05SPH172 343 0 343
40 Main FCCU V300R010C05SPH172 343 0 343
41 Main FCCU V300R010C05SPH172 343 0 343
42 Main FCCU V300R010C05SPH172 343 0 343
43 Main FCCU V300R010C05SPH172 343 0 343
44 Main FCCU V300R010C05SPH172 343 0 343
45 Main FCCU V300R010C05SPH172 343 0 343
46 Main FCCU V300R010C05SPH172 343 0 343
47 Main FCCU V300R010C05SPH172 343 0 343
48 Main FCCU V300R010C05SPH172 343 0 343
49 Main FCCU V300R010C05SPH172 343 0 343
50 Main FCCU V300R010C05SPH172 343 0 343
51 Main FCCU V300R010C05SPH172 343 0 343Port Report File
Table 6-7 shows the list of column headers required within the file:
Table 6-7 List of Column Headers
| Header Name | Description |
|---|---|
| Trunk No | Module number |
| Trunk group name | Type of module |
| IFM Module | Type of software |
| Local server port | Local server port |
| Remote URI | Remote URI <IP address>:<port> |
| Master/Slave type | Type primary/secondary |
| Second Remote URI | Second remote URI |
| Second Master/Slave type | Type primary/secondary |
| Techprefix | Tech prefix |
| IsDeleteTechprefix | True/false |
| Protocol Type | Type of protocol |
Sample Port Report File
+++ LOCAL 2023-08-25 10:25:56-15:00 DST
O&M #8435619
%%LST SIPIPPAIR:;%%
RETCODE = 0 Operation succeeded
SIPTG ip pair information
-------------------------
Trunk No Trunk group name IFM Module Local server port Remote URI Master/Slave type Second Remote URI Second Master/Slave type Techprefix IsDeleteTechprefix Protocol Type
5 intx_SAMPLE_XX_sip 132 5060 500.100.10.100:5060 Master 255.255.255.255:65535 Slave NULL True UDP
14 CTE_SAMPLE_XX_MTY_SIP 132 5060 500.100.10.101:5060 Master 255.255.255.255:65535 Slave NULL True UDP
15 CTE__SAMPLE__SIP 132 5060 500.100.10.102:5060 Master 255.255.255.255:65535 Slave NULL False UDP
16 ISF_SAMPLE__LOC 132 5060 500.100.10.103 Master 255.255.255.255:65535 Slave NULL False UDP
20 CTE_SAMPLE___SIP 132 5060 500.100.10.104:5060 Master 255.255.255.255:65535 Slave NULL False UDP
21 CTE_SAMPLE___SIP 132 5060 500.100.10.105:5060 Master 255.255.255.255:65535 Slave NULL False UDP
22 P_AGNYSAMPLESIP 132 5060 500.100.10.106:5060 Master 255.255.255.255:65535 Slave NULL False UDP
23 PBA_IMS_ALU_2 132 5060 500.100.10.107 Master 255.255.255.255:65535 Slave NULL False UDP
24 PBA_SAMPLE___SIP 132 5060 500.100.10.108 Master 255.255.255.255:65535 Slave NULL True UDP
33 PVR_SAMPLE___SIP 132 5060 500.100.10.109:5060 Master 255.255.255.255:65535 Slave NULL False UDP
34 SCOT_SAMPLE__SIP 132 5060 500.100.10.110:5060 Master 255.255.255.255:65535 Slave NULL True UDP
35 CTE_SAMPLE_SIP 132 5060 500.100.10.111:5060 Master 255.255.255.255:65535 Slave NULL True UDP
42 CTE_SAM_NOV1_SIP 132 5060 500.100.10.112:5060 Master 255.255.255.255:65535 Slave NULL False UDP
43 CTE_SAM_NOV2_SIP 132 5060 500.100.10.113:5060 Master 255.255.255.255:65535 Slave NULL False UDP
44 PVR_SAMPLETECAS_OUT_SIP 132 5060 500.100.10.114:5060 Master 255.255.255.255:65535 Slave NULL True UDP
46 CTE_SAMPLE_T_SIP 132 5060 500.100.10.115:5060 Master 255.255.255.255:65535 Slave NULL False UDP
47 CTE_SAMPLEL_SIP2 132 5060 500.100.10.116:5060 Master 255.255.255.255:65535 Slave NULL False UDP
49 CUCMX_SAMPLE_SIP 132 5060 500.100.10.117:5060 Master 255.255.255.255:65535 Slave NULL False UDP