Filters

User Manuals : FOXMAN-UN Northbound Interface - User Manual : Inventory report interface : General : Syntax : Filters

Filters

In addition to using the address to select appropriate objects for a report, an optional filter can be set. The format for a filter is

Filter (<filterDefinition>)

«filterDefinition» is a boolean expression. Logical operators are «and» and «or». The following operators for comparisons can be used:

=	equal
!=	not equal
<	smaller than (not applicable for strings)
<=	smaller or equal than (not applicable for strings)
>	greater than (not applicable for strings)
>=	greater or equal than (not applicable for strings)

Strings containing special characters must be enclosed by double quotes.

Alphanumeric types can contain the characters a-z, A-Z, 0-9, the special characters , . ; : as well as space.

In strings, asterisk (*) can be used as a wildcard in the filter definitions.

Available filter items depend on the requested report type. The names of the filter items are case sensitive.

Filter items for a NE report:

Filter item	xml item	Data type	Comment
neId	neId	Numeric	Internal NE identifier
networkId	networkId	Numeric	Internal agent identifier
accessType	accessType 1)	Numeric	1)
name	name	Alphanumeric	NE name
tag	tag	Alphanumeric	NE tag
location	location	Alphanumeric	NE location
additionalText	additionalText	Alphanumeric	NE operator message
type	type 2)	Numeric	NE type 2)
ipAddress	ipAddress	Numeric	NE IP address in full decimal
isPollingOn	isPollingOn 3)	Boolean	3)
hdlcAddress	hdlcAddress	Numeric
hdlcRouterType	hdlcRouterType	Numeric	4)
dialUpNumber	dialUpNumber	Alphanumeric
gatewayIPAddress	gatewayIPAddress	Numeric
gatewayTCPPort	gatewayTCPPort	Numeric
currentConfigId	currentConfigId	Alphanumeric
oldConfigId	not part of report	Alphanumeric
state	not part of report	Numeric	Management status 5)
additionalInfo	not part of report	Alphanumeric	not suitable for filtering

1) Valid values are:

0 = Permanent	4 = EOC
1 = RemotePermanent	5 = ATU
2 = DirectPTP	6 = Q1
3 = ModemPTP

2) Valid values are:

0 = FOX-U	10 = COLT_EC
1 = FOX-U/M	12 = FOX615
2 = FOX-U/E	16 = SNMPType
3 = COLT2	18 = FOX612
4 = DESKTOP	20 = FOX615
5 = N/A	21 = FOX612
6 = N/A
7 = FOX515
8 = FOX512
9 = COLT_E

3) Valid values are:

0 = false

1 = true

4) Valid values are:

0 = SerialRouter

1 = FOX515

5) Valid values are:

0 = NotConfigured	2 = DifferentConf
1 = NotManageable	3 = Manageable

Filter items for a Unit report:

Filter item	xml item	Data type	Comment
unitId	id	Numeric	Internal unit identifier
neId	neId	Numeric	Internal NE identifier
slot	slotId	Numeric	Slot number
layer	layerId	Alphanumeric
subunit	subUnitId	Numeric	Internal subunit identifier
cfgName	cfgName	Alphanumeric
cfgIdentity	cfgIdentity	Alphanumeric
cfgDescription	cfgDescription	Alphanumeric
hwName	hwName	Alphanumeric	Hardware name
hwIdentity	hwIdentity	Alphanumeric	Hardware identity
hwVersion	hwVersion	Alphanumeric	Hardware version
hwKey	hwKey	Alphanumeric	Hardware key
swName	swName	Alphanumeric	Software name
swVersion	swVersion	Alphanumeric	Software version
boardId	boardId	Numeric	Board identity
supplierPN	supplierPN	Alphanumeric	Supplier part number
manufacturerID	manufacturerID	Alphanumeric	Manufacturer identifier
manufacturerSN	manufacturerSN	Alphanumeric	Manufacturer serial number
manufacturerPN	manufacturerPN	Alphanumeric	Manufacturer part number
deliveryDate	deliveryDate	Alphanumeric	e.g. «06W24»
blName	blName	Alphanumeric	Bootloader name
blVersion	blVersion	Alphanumeric	Bootloader version
customerID	customerID	Alphanumeric	Customer identifier
customerPN	customerPN	Alphanumeric	Customer part number
nofPorts	nofPorts	Numeric	Number of ports
supplierBuildState	supplierBuildState	Alphanumeric
manufacturerBuildState	manufacturerBuildState	Alphanumeric
layerName	layerName	Alphanumeric
status	configStatus	Alphanumeric	SW DL configuration status
immediateSoftware	immediateSW	Alphanumeric
scheduledSoftware	scheduledSW	Alphanumeric
installTime	installTime	Numeric
compilationDate	compileDate	Numeric
lastInventoryCollectTime	not in report	Numeric
additionalInfo	not in report	Alphanumeric	not suitable for filtering

Filter items for a Port report:

Filter item	xml item	Data type	Comment
ttpId	id	Numeric	Internal port identifier
neId	neId	Numeric	Internal NE identifier
slot	slotId	Numeric
subSlot	subSlot	Numeric
portNumber	portNumber	Numeric
portTTPId	portTTPId	Numeric
unitType	unitName	Alphanumeric
label	label	Alphanumeric
layerRate	layerRate	Alphanumeric	1)
nbOf64k	nbOf64k	Alphanumeric	Number of 64k
isActive	isActive	Boolean	2)
allocatedBandwidth	allocatedBW	Numeric
totalBandwidth	totalBW	Numeric
configState	configState	Alphanumeric
adminState	adminState	Alphanumeric
hasCASProcessing	not in report	Boolean	2)
supportCASInLastTS	not in report	Boolean	2)
ttpPortType	not in report	Numeric	3)
sector	not in report	Numeric
mode	not in report	Numeric
needProtectionWithSameChannel	not in report	Boolean	2)
canProtectionInSNCPI	not in report	Boolean	2)
retrieveProtectionSupported	not in report	Boolean	2)
connectionType	not in report	Numeric	4)
connectedChannelsMustMatch	not in report	Boolean	2)
additionalInfo	not in report	Alphanumeric

1) Valid values are:

UndefinedRate	STM1 PMS	ADSL Line
P0_nc	STM4 PMS	E-SHDSL
E0	STM16 PMS	Clock Distribution
E12	O22	Ethernet
E22	Unknown	CSMACD Ethernet
E31	E-DSL	E-VDSL
E32

2) Valid values are:

0 = false

1 = true

3) Valid values are:

0 = ExternalOpticalPort	4 = InternalFixedLink
1 = ExternalElectricalPort	5 = InternalFloatingLink
2 = InternalSectionPort	6 = ExternalSFPPort
3 = InternalLogicalPort	7 = Radioport-Minilink

4) Valid values are:

0 = NoConnection	4 = AggregateConnection
1 = FixedConnection	5 = OnBoardFullConnection
2 = FullConnection	6 = OnBoardAccessConnection
3 = AccessConnection	7 = OnBoardAggregateConnection

Filter items for a Service report:

Filter item	xml item	Data type	Comment
neId	neId	Numeric	Internal NE identifier

Filter items for a FOX51x Config report:

Filter item	xml item	Data type	Comment
neId	neId	Numeric	Internal NE identifier
networkId	networkId	Numeric	Internal agent identifier
accessType	accessType 1)	Numeric	1)
name	name	Alphanumeric	NE name
tag	tag	Alphanumeric	NE tag
type	type 2)	Numeric	NE type 2)
isPollingOn	isPollingOn 3)	Boolean	3)

1) Valid values are:

0 = Permanent	4 = EOC
1 = RemotePermanent	5 = ATU
2 = DirectPTP	6 = Q1
3 = ModemPTP

2) Valid values are:

0 = FOX-U	7 = FOX515
1 = FOX-U/M	8 = FOX512
2 = FOX-U/E	9 = COLT_E
3 = COLT2	10 = COLT_EC

3) Valid values are:

0 = false

1 = true

Example for a NE report filter that delivers a report of all NEs assigned to the agents with the networkId 1 and 3:

filter (networkId=1 and networkId=3)