new()
AddNodeB()
AddENBFunction()
AddPLMN()
AddLteInterface()
AddAntennaFunction()
AddSectorId()
AddEUtranCell()
AddEUtranSector()
AddAntennaSerialToSector()
AddConnectedMME()
AddConnectedSGW()
AddOAMConnection()
AddLocationData()
AddMME()
AddMMEFunction()
AddSGW()
AddSGWFunction()
AddPGW()
AddPGWFunction()
AddHSS()
AddHSSFunction()
AddPCRF()
AddPCRFFunction()
AddEIR()
AddEIRFunction()
GetENBFunction()
GetMMEFunction()
GetMMEFunction()
GetPGWFunction()
GetHSSFunction()
GetPCRFFunction()
AddLTEExtraInfo()
GetEIRFunction()
GetEUtranSector()
GetAntennaFunction()
GetENodeBData()
GetMMEData()
GetPGWData()
GetSGWData()
GetHSSData()
GetPCRFData()
GetEIRData()
Collector::Store::LteDataStore - module to hold LTE data for collectors
my $store = new Collector::Store::LteDataStore( debug => $debugLevel, name => "LteCollectorStoreTest", description => "Store to test LteDataStore" );
my $dataSourceId = 1;
$store->AddENodeB( 1, "ENodeB1", { parentChassisId => "chass1", parentChassisDn => "chass1Dn" } ); $store->AddMME(1, "MME1", { parentChassisId => "chass2", parentChassisDn => "chass2Dn" } ); $store->AddSGW(1, "SGW1", { parentChassisId => "chass3", parentChassisDn => "chass3Dn" } ); $store->AddPGW(1, "PGW1", { parentChassisId => "chass4", parentChassisDn => "chass4Dn" } ); $store->AddHSS(1, "HSS1", { parentChassisId => "chass5", parentChassisDn => "chass5Dn" } ); $store->AddPCRF(1, "PCRF1", { parentChassisId => "chass6", parentChassisDn => "chass6Dn" } ); $store->AddEIR(1, "EIR1", { parentChassisId => "chass9", parentChassisDn => "chass9Dn" } );
my $ENBfunRef = $store->AddENBFunction(1, "ENodeB1", "ENBFunction1", "Nokia-Siemens", { eNodeBName => string, maximumOutPutPower => int, userCapacity => int });
$store->AddLteInterface($ENBfunRef, "S1-MME", { lteInterfaceDescription => string, ipAddress => string, subNet => string });
$store->AddPLMN($ENBfunRef, { mcc => string, mnc => string } );
my $antennaRef = $store->AddAntennaFunction($ENBfunRef, "123214354", { antennaHeight => int, antennaDownTilt => int, antennaLatitude => int, antennaLongitude => int, antennaManufacturer => string } );
$store->AddSectorId($antennaRef, 123);
my $sectorRef = $store->AddEUtranSector($ENBfunRef, "SectorID-125", { sectorName => string, sectorNumber => 489, frequencyBand => 3, maximumOutputPower => 11, distinguishedName => string, operationalState => string, administrativeState => string });
$store->AddConnectedMME($ENBfunRef, "MME1", { mmeCode => string, mmeGroupId => string, mmeMcc => string, mmeMnc => string, mmeIpAddress => string, mmeLinkWeight => int, mmeLinkUsage => string }); $store->AddConnectedSGW($ENBfunRef, "SGW1", { sgwIpAddr => string, sgwLinkWeight => int, sgwLinkUsage => string });
my $mmeFunRef = $store->AddMMEFunction(1, "MME1", "MMEFunction1", "Nokia-Siemens", { mmeCode => string, mmeGroupId => string, mmePoolName => string, supportedPLMNs => string, operationalState => string, administrativeState => string, vendorModuleType => string, softwareVersion => string, distinguishedName => string, emsIpAddress => string });
my $pgwRef = $store->AddPGWFunction(1, "PGW1", "PGWFunction1", "Nokia-Siemens", { supportedPLMNs => string, operationalState => string, administrativeState => string, vendorModuleType => string, softwareVersion => string, distinguishedName => string, emsIpAddress => string });
my $sgwFunRef = $store->AddSGWFunction(1, "SGW1", "SGWFunction1", "Nokia-Siemens", { supportedPLMNs => string, operationalState => string, administrativeState => string, vendorModuleType => string, softwareVersion => string, distinguishedName => string, emsIpAddress => string });
my $hssRef = $store->AddHSSFunction(1, "HSS1", "HSSFunction1", "Nokia-Siemens", { supportedPLMNs => string, operationalState => string, administrativeState => string, vendorModuleType => string, softwareVersion => string, distinguishedName => string, emsIpAddress => string });
my $eirRef = $store->AddEIRFunction(1, "EIR1", "EIRFunction1", "Nokia-Siemens", { supportedPLMNs => string, operationalState => string, administrativeState => string, vendorModuleType => string, softwareVersion => string, distinguishedName => string, emsIpAddress => string });
my$ pcrfRef = $store->AddPCRFFunction(1, "PCRF1", "PCRFFunction1", "Nokia-Siemens", { supportedPLMNs => string, operationalState => string, administrativeState => string, vendorModuleType => string, softwareVersion => string, distinguishedName => string, emsIpAddress => string });
$store->AddOAMConnection($ENBfunRef, { oamName => "OAM45", oamIpAddr => "172.20.1.4", oamLinkWeight => 9, oamLinkUsage => "Other"});
$store->AddS1MMEConnection($mmeFunRef, { eNodeBName => "ENB1", eNodeBIpAddr => "9.23.2.1", s1mmeLinkWeight => 3, s1mmeLinkUsage => "Other" });
$store->AddS3Connection($mmeFunRef, { sgsnName => "SGSN1", sgsnIpAddr => "2.43.2.1", s3LinkWeight => 9, s3LinkUsage => "Other" });
$store->AddS4Connection($sgwFunRef, { sgsnName => "SGSN1", sgsnIpAddr => "9.180.209.33", s4LinkWeight => 5, s4LinkUsage => "Primary"});
$store->AddS5Connection($sgwFunRef, { pgwName => "PGW4", pgwIpAddr => "172.20.1.5", s5LinkWeight => 3, s5LinkUsage => "Backup"});
$store->AddS8Connection($sgwFunRef, { pgwName => "PGW8", pgwIpAddr => "173.20.1.5", s8LinkWeight => 7, s8LinkUsage => "Backup"});
$store->AddS6aConnection($mmeFunRef, { hssName => "HSS1", hssIpAddr => "7.3.67.2", s6aLinkWeight => 2, s6aLinkUsage => "Prmary" });
$store->AddS10Connection($mmeFunRef, { mmeName => "MME2", mmeCode => "MMECODE23", mmeGroupId => "GROUP12", mmeMcc => "2", mmeMnc => "3", mmeIpAddr => "98.23.2.1", s10LinkWeight => 4, s10LinkUsage => "Backup" });
$store->AddS11Connection($mmeFunRef, { sgwName => "SGW2", sgwIpAddr => "172.20.3.2", s11LinkWeight => 4, s11LinkUsage => "Other" });
$store->AddS13Connection($mmeFunRef, { eirName => "EIR2", eirIpAddr => "192.168.2.55", s13LinkWeight => 3, s13LinkUsage => "Primary" });
my $funRef2 = $store->GetENBFunction(1, "ENodeB1", "ENBFunction1"); $store->AddPLMN($funRef2, { mcc => "MCC2", mnc => "MNC2" } );
my $sectorRef2 = $store->GetEUtranSector($funRef2, "SectorID-125"); $store->AddAntennaSerialToSector($sectorRef2,"999");
my $antennaRef2 = $store->GetAntennaFunction($funRef2, "123214354"); $store->AddSectorId($antennaRef2, 789);
This module extends the API offered by the Collector::Store module to provide functions to allow a Collector to store Long Term Evolution (LTE) data.
This extends the API provided by Collector::Store with the methods listed below.
Note: The base Collector::Store AddDeviceData()
method is expected to be used
to add additional device information, such as BaseName (eg a DNS name).
AddENBFunction()
AddMMEFunction()
AddPGWFunction()
AddSGWFunction()
AddHSSFunction()
AddEIRFunction()
AddPCRFFunction()
AddOAMConnection()
GetEUtranSector()
GetAntennaFunction()
GetMMEFunction()
GetPGWFunction()
GetSGWFunction()
GetHSSFunction()
GetPCRFFunction()
GetEIRFunction()
API methods are described below.
new()
Creates an instance of the LteDataStore. A single Store, which may be a LteDataStore, is expected per Collector.
- Arguments
This accepts an optional hash with the fields below.
debug: Debug level (0 to disable or 1 to enable)
name: Textual name of the collector
description: Textual description of the collector. Ignored if name is not also given.
- Return Value
Returns the new LteDataStore (blessed object reference)
Examples
# Create and initialise a LteDataStore with a single source (eg # accessing a single EMS) my $store = new Collector::Store::LteDataStore( name => "LteCollectorStore", description => "Store for LTE data" );$store->SetupDataSources( [ { Id => 1, Descr => "Single data source" } ] );
AddNodeB()
Adds an ENodeB to the store
- Arguments
Expects 3 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the pre-existing device containing the ENodeB
data: Hash reference of the following optional fields:
parentChassisId (string) Identifier of the parent physical Chassis parentChassisDn (string) EMS distinguished name of the parent phsysical Chassis
AddENBFunction()
Adds an ENBFunction to the store
- Arguments
Expects 5 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the ENodeB to which we want to add an ENodeBFunction
functionId: Unique textual id of the ENBFunction
vendorName: Vendor Name
data: Hash reference of the following optional fields:
eNodeBName (string) A name given to this ENodeBFunction maximumOutPutPower (integer) Maximum output power in Watts userCapacity (integer) Maximum number of UEs that can connect simultaniously supportedPLMNs (int) The count of the number of mobile networks which are serviced by the function operationalState (string) valid values are Enabled, Disabled, Other, Unknown administrativeState (string) valid values are Unlocked, Locked or Shutting Down, Other, Unknown vendorModuleType (string) Vendor specific MME Type softwareVersion (string) Vendor specific MME sofware version distinguishedName (string) The distinguished name by which the ENB is known to its element management system (EMS) emsIpAddress (string) The IP address of the element management system backHaulConnection (string) The IP address of the first hop backhaul connection (e.g. cell site router)- Return Value
A reference to the created ENBFunction
AddPLMN()
Adds a PLMN (Public land mobile network) to a function's PLMN list
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
mcc (string) Mobile country code mnc (string) Mobile network code
AddLteInterface()
Adds an LTE Interface to a function's interface list
- Arguments
Expects 3 arguments.
functionRef: A reference to the function to be added to
interfaceType: Protocol type. Values can be S1-MME S1-U S3 S4 S5 S6a S8 S10 S11 S13 X2 Gx OAM
data: Hash reference of the following optional fields:
lteInterfaceDescription (string) EMS's description of interface parentInterface (string) parent Interface ipAddress (string) IP Address of interface subNet (string) Subnet of interface vLan (string) Vlan of interface
AddAntennaFunction()
Adds an AntennaFunction to an ENodeB function
- Arguments
Expects 3 arguments.
functionRef: A reference to the ENB function to be added to
antennaSerial: The unique serial number of the antenna
data: Hash reference of the following optional fields:
antennaHeight (string) Height of antenna antennaDownTilt (int) Antenna downtilit antennaBearing (int) Antenna bearing antennaMaxAzimuth (int) Antenna max azimuth antennaMinAzimuth (int) Antenna mix azimuth antennaHorizontalBeamwidth (int) Antenna horizontal beamwidth antennaVerticalBeamwidth (int) Antenna vertical beamwidth antennaLatitude (int) Antenna latitude antennaLongitude (int) Antenna longitude antennaLocationName (int) Antenna location name antennaManufacturer (int) Antenna manufacturer antennaModel (int) Antenna model distinguishedName (int) The EMS's name of the antenna
- Return Value
Returns a reference to the created AntennaFunction
AddSectorId()
Adds a sector to an antenna function's list
- Arguments
Expects 2 arguments.
antennaRef: A reference to the antenna function to be added to
sectorId: The id of the sector
Adds an X2 Neighbour connection to an ENodeB Function
- Arguments
Expects 3 arguments.
functionRef: A reference to the ENB function to be added to
adjENodeBId: The id of the adjacent ENodeB
data: Hash reference of the following optional fields:
adjENodeBIpAddr (string) IP Address of adjacent ENodeB adjENodeBName (string) Name of adjacent ENodeB
AddEUtranCell()
Adds an EUtranCell to an ENodeB Function
- Arguments
Expects 5 arguments.
functionRef: A reference to the ENB function to be added to
eUtranCellId: Uniquely identifies a cell within a PLMN. It is often constructed from eNodeB ID + Physical Cell ID
eUtranCellName: Cell Identifier , Name of the Cell
sectorId:
data: Hash reference of the following optional fields:
physicalCellId (int) Physical Cell ID ( 0-503 ). The physical cell id is used by the cell to encode and decode the data that it transmits. It is used in a similar way to the UMTS scrambling code. To avoid interference neighbouring cells should have different physical cell ids. The physical cell id is derived from the primary and secondary synchronization signals (PSS and SSS). PSS takes a value from 0 .. 2, SSS takes a value from 0 .. 167, and physical cell id = PSS + 3*SSS i.e. a value of between 0 and 503. localCellId (int) The local cell id unique within the eNodeB channelBandwidthDl (int) Uplink channel bandwidth: 3, 5,10,15, 20 Unit : MHz channelBandwidthUl (int) Downlink channel bandwidth: 3, 5,10,15, 20 Unit : MHz maximumOutputPower (float) This is the maximum power for all downlink channels that are allowed to be used simultaneously in a cell, added together. Unit: Watt userCapacity (int) Maximum number of UEs that can connect to this eUtranCell simultaneously. earfcnDl (int) E-UTRA Absolute Radio Frequency Channel Number (downlink). An integer value which identifies the downlink carrier frequency of the cell. earfcnUl (int) E-UTRA Absolute Radio Frequency Channel Number (uplink). An integer value which identifies the uplink carrier frequency of the cell. tac (string) Tracking Area Identifier of the cell (Stored in ncim.trackingArea table) operationalState (string) Enabled, Disabled, Other, Unknown administrativeState (string) Unlocked, Locked, Shutting Down, Other, Unknown sectorName distinguishedName (string) The distinguished name by which the eUtranCell is known to its (EMS)
AddEUtranSector()
Adds an EUtranCell to an ENodeB Function
- Arguments
Expects 3 arguments.
functionRef: A reference to the ENB function to be added to
sectorId:
data: Hash reference of the following optional fields:
sectorName (string) Sector Name sectorNumber (int) Sector Number frequencyBand (int) Identifies the frequency band supported by the sector. All cells serviced by the sector must have carrier frequencies falling within this band. maximumOutputPower (float) The available sector power in watts operationalState (string) Enabled, Disabled, Other, Unknown administrativeState (string) Unlocked, Locked, Shutting Down, Other, Unknown distinguishedName (string) The distinguished name by which the eUtranCell is known to its (EMS)
- Return Value
Returns a reference to the created EUtranSector
AddAntennaSerialToSector()
Adds an Antenna to a Sector's list
- Arguments
Expects 2 arguments.
sectorRef: A reference to the EUtranSector to be added to
serial: Serial number of the antenna
AddConnectedMME()
Adds an MME Neighbour connection to an ENodeB Function
- Arguments
Expects 3 arguments.
functionRef: A reference to the ENB function to be added to
mmeName: The name of the adjacent MME
data: Hash reference of the following optional fields:
mmeCode (string) MME Code: Uniquely identifies an MME within an MME Group (8 bits) mmeGroupId (string) MME Group Identifier: Uniquely identifies an MME Group within the PLMN (16 bits) mmeMcc (string) Mobile Country Code (MCC) of the PRIMARY PLMN supported by the MME mmeMnc (string) Mobile Network Code (MNC) of the PRIMARY PLMN supported by the MME mmeIpAddress (string) IP Address of the MME mmeLinkWeight (float) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. mmeLinkUsage (string) Primary, Secondary, Backup, Other.
AddConnectedSGW()
Adds an SGW Neighbour connection to an ENodeB Function
- Arguments
Expects 3 arguments.
functionRef: A reference to the ENB function to be added to
mmeName: The name of the adjacent SGW
data: Hash reference of the following optional fields:
sgwIpAddress (string) IP Address of the adjacent SGW sgwLinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. sgwLinkUsage (string) Primary, Secondary, Backup, Other.
AddOAMConnection()
Adds an OAM to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
oamName (string) Name of adjacent device oamIpAddr (string) IP Address of adjacent device oamLinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. oamLinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S1MME to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
eNodeBName (string) Name of adjacent device eNodeBIPAddr (string) IP Address of adjacent device s1mmeLinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s1mmeLinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S3 connection to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
sgsnName (string) Name of adjacent device sgsnIPAddr (string) IP Address of adjacent device s3LinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s3LinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S6a to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
hssName (string) Name of adjacent device hssIPAddr (string) IP Address of adjacent device mmeName (string) Name of adjacent device mmeIPAddr (string) IP Address of adjacent device s6aLinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s6aLinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S10 connection to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
mmeName (string) Name of adjacent device mmeIPAddr (string) IP Address of adjacent device mmeCode (string) MME Code: Uniquely identifies an MME within an MME Group (8 bits) mmeGroupId (string) MME Group Identifier: Uniquely identifies an MME Group within the PLMN (16 bits) mmeMcc (string) Mobile Country Code (MCC) of the PRIMARY PLMN supported by the MME mmeMnc (string) Mobile Network Code (MNC) of the PRIMARY PLMN supported by the MME s10LinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s10LinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S1u connection to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
eNodeBName (string) Name of adjacent device eNodeBIPAddr (string) IP Address of adjacent device s1uLinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s1uLinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S11 connection to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
sgwName (string) Name of adjacent device sgwIPAddr (string) IP Address of adjacent device mmeName (string) Name of adjacent device mmeIPAddr (string) IP Address of adjacent device mmeCode (string) MME Code: Uniquely identifies an MME within an MME Group (8 bits) mmeGroupId (string) MME Group Identifier: Uniquely identifies an MME Group within the PLMN (16 bits) mmeMcc (string) Mobile Country Code (MCC) of the PRIMARY PLMN supported by the MME mmeMnc (string) Mobile Network Code (MNC) of the PRIMARY PLMN supported by the MME s11LinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s11LinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S13 connection to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
eirName (string) Name of adjacent device eirIPAddr (string) IP Address of adjacent device mmeName (string) Name of adjacent device mmeIPAddr (string) IP Address of adjacent device s13LinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s13LinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S4 connection to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
sgsnName (string) Name of adjacent device sgsnIPAddr (string) IP Address of adjacent device s4LinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s4LinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S5 connection to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
sgwName (string) Name of adjacent device sgwIPAddr (string) IP Address of adjacent device pgwName (string) Name of adjacent device pgwIPAddr (string) IP Address of adjacent device s5LinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s5LinkUsage (string) Primary, Secondary, Backup, Other.
Adds an S8 connection to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
sgwName (string) Name of adjacent device sgwIPAddr (string) IP Address of adjacent device pgwName (string) Name of adjacent device pgwIPAddr (string) IP Address of adjacent device s8LinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. s8LinkUsage (string) Primary, Secondary, Backup, Other.
Adds an SGx connection to an LTE Function
- Arguments
Expects 2 arguments.
functionRef: A reference to the function to be added to
data: Hash reference of the following optional fields:
pgwName (string) Name of adjacent device pgwIPAddr (string) IP Address of adjacent device pcrfName (string) Name of adjacent device pcrfIPAddr (string) IP Address of adjacent device GxLinkWeight (string) An indication of the relative probability that the link will be used from the perspective of the A-end. For example if an enbFunction has an S1-MME link to 3 mmeFunctions then the interfaceWeight would indicate the liklihood that each of the 3 links would be used. The weight is expressed as a percentage, so in this example might take the values 50, 30, 20 for each of the three links. GxLinkUsage (string) Primary, Secondary, Backup, Other.
AddLocationData()
Adds location data to an LTE Chassis
- Arguments
Expects 3 arguments.
sourceId: Data source id to use
deviceId: Unique textual deviceId of the chassis to which we want to add location data
data: Hash reference of the following optional fields:
locationName (string) The location identifier by which the location is known to the end-user latitude (string) This is the angular distance (east and west) from the prime meridian on the earth's surface. e.g. 35.832636. Based on WGS84 standard. longitude (string) This is the angular distance (north and south) from the equator on the earth's surface. e.g. -78.838753. Based on WGS84 standard. altitude (int) This is the vertical height above WGS84 datum surface (EGM96) at the particular geographical location timezoneOffset (string) Offset of local time from UTC in format UTC-HH:MM or UTC+HH:MM e.g. UTC+10:30, UTC-6:00
AddMME()
Adds an MME to the store
- Arguments
Expects 3 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the pre-existing device containing the MME
data: Hash reference of the following optional fields:
parentChassisId (string) Identifier of the parent physical Chassis parentChassisDn (string) EMS distinguished name of the parent phsysical Chassis
AddMMEFunction()
Adds an MMEFunction to the store
- Arguments
Expects 5 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the MME to which we want to add an MMEFunction
functionId: Unique textual id of the MMEFunction
vendorName: Vendor Name
data: Hash reference of the following optional fields:
mmeName (string) A name given to this MMEFunction mmeCode (string) Identifies an MME within an MME Group (8 bits) mmeGroupId (string) Uniquely identifies an MME Group within the PLMN (16 bits) mmePoolName (string) Name of the MME Pool to which the MME belongs. supportedPLMNs (int) The count of the number of mobile networks which are serviced by the function operationalState (string) valid values are Enabled, Disabled, Other, Unknown administrativeState (string) valid values are Unlocked, Locked or Shutting Down, Other, Unknown vendorModuleType (string) Vendor specific MME Type softwareVersion (string) Vendor specific MME sofware version distinguishedName (string) The distinguished name by which the MME is known to its element management system (EMS) emsIpAddress (string) The IP address of the element management system- Return Value
A reference to the created MMEFunction
AddSGW()
Adds an SGW to the store
- Arguments
Expects 3 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the pre-existing device containing the SGW
data: Hash reference of the following optional fields:
parentChassisId (string) Identifier of the parent physical Chassis parentChassisDn (string) EMS distinguished name of the parent phsysical Chassis
AddSGWFunction()
Adds an SGWFunction to the store
- Arguments
Expects 5 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the SGW to which we want to add an SGWFunction
functionId: Unique textual id of the SGWFunction
vendorName: Vendor Name
data: Hash reference of the following optional fields:
supportedPLMNs operationalState (string) valid values are Enabled, Disabled, Other, Unknown administrativeState (string) valid values are Unlocked, Locked or Shutting Down, Other, Unknown vendorModuleType (string) Vendor specific SGW Type softwareVersion (string) Vendor specific SGW sofware version distinguishedName (string) The distinguished name by which the SGW is known to its element management system (EMS) emsIpAddress (string) The IP address of the element management system- Return Value
A reference to the created SGWFunction
AddPGW()
Adds a PGW to the store
- Arguments
Expects 3 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the pre-existing device containing the PGW
data: Hash reference of the following optional fields:
parentChassisId (string) Identifier of the parent physical Chassis parentChassisDn (string) EMS distinguished name of the parent phsysical Chassis
AddPGWFunction()
Adds an PGWFunction to the store
- Arguments
Expects 5 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the PGW to which we want to add an PGWFunction
functionId: Unique textual id of the PGWFunction
vendorName: Vendor Name
data: Hash reference of the following optional fields:
supportedPLMNs operationalState (string) valid values are Enabled, Disabled, Other, Unknown administrativeState (string) valid values are Unlocked, Locked or Shutting Down, Other, Unknown vendorModuleType (string) Vendor specific PGW Type softwareVersion (string) Vendor specific PGW sofware version distinguishedName (string) The distinguished name by which the PGW is known to its element management system (EMS) emsIpAddress (string) The IP address of the element management system- Return Value
A reference to the created PGWFunction
AddHSS()
Adds an HSS to the store
- Arguments
Expects 3 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the pre-existing device containing the HSS
data: Hash reference of the following optional fields:
parentChassisId (string) Identifier of the parent physical Chassis parentChassisDn (string) EMS distinguished name of the parent phsysical Chassis
AddHSSFunction()
Adds an HSSFunction to the store
- Arguments
Expects 5 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the HSS to which we want to add an HSSFunction
functionId: Unique textual id of the HSSFunction
vendorName: Vendor Name
data: Hash reference of the following optional fields:
supportedPLMNs operationalState (string) valid values are Enabled, Disabled, Other, Unknown administrativeState (string) valid values are Unlocked, Locked or Shutting Down, Other, Unknown vendorModuleType (string) Vendor specific HSS Type softwareVersion (string) Vendor specific HSS sofware version distinguishedName (string) The distinguished name by which the HSS is known to its element management system (EMS) emsIpAddress (string) The IP address of the element management system- Return Value
A reference to the created HSSFunction
AddPCRF()
Adds a PCRF to the store
- Arguments
Expects 3 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the pre-existing device containing the PCRF
data: Hash reference of the following optional fields:
parentChassisId (string) Identifier of the parent physical Chassis parentChassisDn (string) EMS distinguished name of the parent phsysical Chassis
AddPCRFFunction()
Adds an PCRFFunction to the store
- Arguments
Expects 5 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the PCRF to which we want to add an PCRFFunction
functionId: Unique textual id of the PCRFFunction
vendorName: Vendor Name
data: Hash reference of the following optional fields:
supportedPLMNs operationalState (string) valid values are Enabled, Disabled, Other, Unknown administrativeState (string) valid values are Unlocked, Locked or Shutting Down, Other, Unknown vendorModuleType (string) Vendor specific PCRF Type softwareVersion (string) Vendor specific PCRF sofware version distinguishedName (string) The distinguished name by which the PCRF is known to its element management system (EMS) emsIpAddress (string) The IP address of the element management system- Return Value
A reference to the created PCRFFunction
AddEIR()
Adds an EIR to the store
- Arguments
Expects 3 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the pre-existing device containing the EIR
data: Hash reference of the following optional fields:
parentChassisId (string) Identifier of the parent physical Chassis parentChassisDn (string) EMS distinguished name of the parent phsysical Chassis
AddEIRFunction()
Adds an EIRFunction to the store
- Arguments
Expects 5 arguments.
sourceId: Data source id to add device data to (often a single source per collector)
deviceId: Unique textual deviceId of the EIR to which we want to add an EIRFunction
functionId: Unique textual id of the EIRFunction
vendorName: Vendor Name
data: Hash reference of the following optional fields:
supportedPLMNs operationalState (string) valid values are Enabled, Disabled, Other, Unknown administrativeState (string) valid values are Unlocked, Locked or Shutting Down, Other, Unknown vendorModuleType (string) Vendor specific EIR Type softwareVersion (string) Vendor specific EIR sofware version distinguishedName (string) The distinguished name by which the EIR is known to its element management system (EMS) emsIpAddress (string) The IP address of the element management system- Return Value
A reference to the created EIRFunction
GetENBFunction()
Finds an ENodeBFunction in an ENodeB and rturns a Perl reference to it.
- Arguments
Expects 3 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Unique textual deviceId of the ENodeB to search
eNodeBId The unique id of the ENodeBFunction in the EnodeB
- Return reference
Returns a reference to the ENBFunction if found
GetMMEFunction()
Finds an MMEFunction in an MME and rturns a Perl reference to it.
- Arguments
Expects 3 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Unique textual deviceId of the MME to search
mmeName The unique id of the MME Function in the MME
- Return reference
Returns a reference to the MMEFunction if found
GetMMEFunction()
Finds an SGWFunction in an SGW and rturns a Perl reference to it.
- Arguments
Expects 3 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Unique textual deviceId of the SGW to search
sgwName The unique id of the SGWFunction in the SGW
- Return reference
Returns a reference to the SGWFunction if found
GetPGWFunction()
Finds an PWFunction in an PGW and rturns a Perl reference to it.
- Arguments
Expects 3 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Unique textual deviceId of the PGW to search
pgwName The unique id of the PGWFunction in the PGW
- Return reference
Returns a reference to the PGWFunction if found
GetHSSFunction()
Finds an HSSFunction in an HSS and rturns a Perl reference to it.
- Arguments
Expects 3 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Unique textual deviceId of the HSS to search
hssName The unique id of the HSSFunction in the HSS
- Return reference
Returns a reference to the HSSFunction if found
GetPCRFFunction()
Finds a PCRFFunction in an PCRF and rturns a Perl reference to it.
- Arguments
Expects 3 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Unique textual deviceId of the PCRF to search
pcrfName The unique id of the PCRFFunction in the PCRF
- Return reference
Returns a reference to the PCRFFunction if found
AddLTEExtraInfo()
Adds custom data to the LTEExtraInfo list within a function's lte data This may be more appropriate than the parent chassis' general LTEExtraInfo field This data would need appropriate stitcher customization in order to be transferred to NCIM
- Arguments
Expects 2 arguments.
functionRef A reference to the Function to be added to
data A Hash of key/values to be added to LTEExtraInfo
GetEIRFunction()
Finds an EIRFunction in an EIR and rturns a Perl reference to it.
- Arguments
Expects 3 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Unique textual deviceId of the EIR to search
eirName The unique id of the EIRFunction in the EIR
- Return reference
Returns a reference to the EIRFunction if found
GetEUtranSector()
Finds and returnss a reference to an EutranSector This can be needed if you need to add an anteanna serial to an EUTranSector but don't have a reference to it
- Arguments
Expects 2 arguments.
ENBFunctionRef A reference to the ENBFunction that contains the EUTranSector
sectorId The id (key) of the EUtranSector within the ENBFunction
- Return Value
Returns a reference to the EUtranSector if found
GetAntennaFunction()
Finds and returnss a reference to an AntennaFunction This can be needed if you need to add a sectorId to an antenna but don't have a reference to it
- Arguments
Expects 2 arguments.
ENBFunctionRef A reference to the ENBFunction that contains the AntennaFunction
serialNumber The serial number (key) of the AntennaFunction
- Return Value
Returns a reference to the AntennaFunction if found
GetENodeBData()
Return an XML string defining the LTE data for a given device.
This essentially builds the response to the
GetENodeBData()
XML RPC call.Note: The form of the data is derived from the structure of the CustomData->lteData node of the device. This is not usually of interest to the developer, as the structure is created based on the API methods above. The crucial fact is that this data is structured based on the format of the NCIM tables, with a hash keyed on a table name, containing fields of the same name as the fields in the NCIM table.
- Arguments
Expects 2 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Textual deviceId
- Return Value
Returns an XML string representing the LTE data for the given device, or undef if the device could not be found.
GetMMEData()
Return an XML string defining the LTE data for a given device.
This essentially builds the response to the
GetMMEData()
XML RPC call.Note: The form of the data is derived from the structure of the CustomData->lteData node of the device. This is not usually of interest to the developer, as the structure is created based on the API methods above. The crucial fact is that this data is structured based on the format of the NCIM tables, with a hash keyed on a table name, containing fields of the same name as the fields in the NCIM table.
- Arguments
Expects 2 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Textual deviceId
- Return Value
Returns an XML string representing the LTE data for the given device, or undef if the device could not be found.
GetPGWData()
Return an XML string defining the LTE data for a given device.
This essentially builds the response to the
GetPGWData()
XML RPC call.Note: The form of the data is derived from the structure of the CustomData->lteData node of the device. This is not usually of interest to the developer, as the structure is created based on the API methods above. The crucial fact is that this data is structured based on the format of the NCIM tables, with a hash keyed on a table name, containing fields of the same name as the fields in the NCIM table.
- Arguments
Expects 2 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Textual deviceId
- Return Value
Returns an XML string representing the LTE data for the given device, or undef if the device could not be found.
GetSGWData()
Return an XML string defining the LTE data for a given device.
This essentially builds the response to the
GetSGWData()
XML RPC call.Note: The form of the data is derived from the structure of the CustomData->lteData node of the device. This is not usually of interest to the developer, as the structure is created based on the API methods above. The crucial fact is that this data is structured based on the format of the NCIM tables, with a hash keyed on a table name, containing fields of the same name as the fields in the NCIM table.
- Arguments
Expects 2 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Textual deviceId
- Return Value
Returns an XML string representing the LTE data for the given device, or undef if the device could not be found.
GetHSSData()
Return an XML string defining the LTE data for a given device.
This essentially builds the response to the
GetHSSData()
XML RPC call.Note: The form of the data is derived from the structure of the CustomData->lteData node of the device. This is not usually of interest to the developer, as the structure is created based on the API methods above. The crucial fact is that this data is structured based on the format of the NCIM tables, with a hash keyed on a table name, containing fields of the same name as the fields in the NCIM table.
- Arguments
Expects 2 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Textual deviceId
- Return Value
Returns an XML string representing the LTE data for the given device, or undef if the device could not be found.
GetPCRFData()
Return an XML string defining the LTE data for a given device.
This essentially builds the response to the
GetPCRFData()
XML RPC call.Note: The form of the data is derived from the structure of the CustomData->lteData node of the device. This is not usually of interest to the developer, as the structure is created based on the API methods above. The crucial fact is that this data is structured based on the format of the NCIM tables, with a hash keyed on a table name, containing fields of the same name as the fields in the NCIM table.
- Arguments
Expects 2 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Textual deviceId
- Return Value
Returns an XML string representing the LTE data for the given device, or undef if the device could not be found.
GetEIRData()
Return an XML string defining the LTE data for a given device.
This essentially builds the response to the
GetEIRData()
XML RPC call.Note: The form of the data is derived from the structure of the CustomData->lteData node of the device. This is not usually of interest to the developer, as the structure is created based on the API methods above. The crucial fact is that this data is structured based on the format of the NCIM tables, with a hash keyed on a table name, containing fields of the same name as the fields in the NCIM table.
- Arguments
Expects 2 arguments.
sourceId Data source id to add device data to (often a single source per collector)
deviceId Textual deviceId
- Return Value
Returns an XML string representing the LTE data for the given device, or undef if the device could not be found.