Cisco Cisco Prime Performance Manager 1.5 Developer's Guide
Cisco Prime Performance Manager1.5 REST API Guide
5.7.12 reportObjectFilter
Table 18 – reportObjectFilter Parameter
Parameter
Notes
reportObjectFilter
The reportObjectFilter parameter is used to filter the reporting data using a
specific report column name.
The reportObjectFilter parameter consists of that report column name “Var
name
specific report column name.
The reportObjectFilter parameter consists of that report column name “Var
name
” defined in the corresponding report XML ProcessDBSummary section
followed by a macro or operator and a value.
If you are looking at a dashboard report XML, you would first need to find
the baseTable name for the corresponding WebReport TableView. Then, you
would need to go to the Prime Performance Manager shell system prompt,
and search and find the corresponding ProcessDBSummary web report XML
that contains that table name in the folder “/opt/CSCOppm-
gw/etc/pollers/system”. For example, let’s assume that the baseTable name is
“SNMP”:
$ pwd
/opt/CSCOppm-gw/etc/pollers/system
$ grep -i "\bSNMP\b" *.xml | grep ProcessDBSummary
snmp.xml: <ProcessDBSummary baseTableName="SNMP"
dbnum="3">
In the above case, the file “snmp.xml” contains the ProcessDBSummary with
the “Var name” used for that dashboard report.
Also, another way to find a valid column “Var name” for a given report is
to send a REST query to a report (not dashboard) by passing an invalid
column name followed by macro/operator and value. The REST API should
respond with an error and the listing of valid column names for that report.
Formats:
- supported macro: contains
- supported operators: > < == != => <=
[Var name].contains(“[some text value]”)
not([Var name].contains(“[some text value]”))
[Var name]==”[some text value]”
[Var name]!=”[some text value]”
[Var name]==[number]
[Var name]!=[number]
[Var name]>[number]
[Var name]>=[number]
[Var name]<[number]
[Var name]<=[number]
Examples:
reportObjectFilter=IPSLAOwner.contains(“some+text+va
lue”)
reportObjectFilter=not(IPSLAOwner.contains(“some+tex
If you are looking at a dashboard report XML, you would first need to find
the baseTable name for the corresponding WebReport TableView. Then, you
would need to go to the Prime Performance Manager shell system prompt,
and search and find the corresponding ProcessDBSummary web report XML
that contains that table name in the folder “/opt/CSCOppm-
gw/etc/pollers/system”. For example, let’s assume that the baseTable name is
“SNMP”:
$ pwd
/opt/CSCOppm-gw/etc/pollers/system
$ grep -i "\bSNMP\b" *.xml | grep ProcessDBSummary
snmp.xml: <ProcessDBSummary baseTableName="SNMP"
dbnum="3">
In the above case, the file “snmp.xml” contains the ProcessDBSummary with
the “Var name” used for that dashboard report.
Also, another way to find a valid column “Var name” for a given report is
to send a REST query to a report (not dashboard) by passing an invalid
column name followed by macro/operator and value. The REST API should
respond with an error and the listing of valid column names for that report.
Formats:
- supported macro: contains
- supported operators: > < == != => <=
[Var name].contains(“[some text value]”)
not([Var name].contains(“[some text value]”))
[Var name]==”[some text value]”
[Var name]!=”[some text value]”
[Var name]==[number]
[Var name]!=[number]
[Var name]>[number]
[Var name]>=[number]
[Var name]<[number]
[Var name]<=[number]
Examples:
reportObjectFilter=IPSLAOwner.contains(“some+text+va
lue”)
reportObjectFilter=not(IPSLAOwner.contains(“some+tex