Control Options |
Tunnel Segment |
The Tunnel Segment AID (e.g. TUSEG-1-1-{1- 750}). This is a drop-down list containing all Tunnel Segments that has its PM State set to ON/ OFF in the system. This does not apply to the Tunnel Segment that has its PM State set to DISABLED. |
|
Monitor Type |
Monitored counters type. It identifies the type of monitored registers that are being retrieved. The MONTYPE = ALL displays the set of all PM counters supported by the TUSEG. Valid values:
-
ALL (default)
-
MINP (MPLS Incoming Number of Packets)
-
MINB (MPLS Incoming Number of Bytes)
-
MONP (MPLS Outgoing Number of Packets)
-
MONB (MPLS Outgoing Number of Bytes |
rtrv-tmplspmtuseg:montype |
Monitor Level |
The MONLEV specifies the discrimination level of PM parameter values to be reported for the specified monitored counters (MONTYPE). It is a multiple fields parameter consisting of Level and Direction (see below).
The field specifies the upper or lower boundary of the data reported. It is an integer value in the range of 0- 18446744073709551615. The default value is 1. |
rtrv-tmplspmtuseg:monlev=(level-direction) |
Monitor Direction |
The field specifies whether or not the PM Report includes PM data that does not have a VLDTY (Validity) flag of CMPL. It also specifies the Monitor Level value entered in the above field is upper or lower boundary of the reporting data. Valid value:
-
DN — Down. Only PM data for the specified MONTYPE that is less than or equal to the value of <LEVEL> is reported.
-
DNORNCMPL — Down or Not Complete. Only PM data for the specified MONTYPE that is less than or equal to the value of <LEVEL>, or that does not have a VLDTY (Validity) flag of CMPL, is reported.
-
UP — Up. Only PM data for the specified MONTYPE that is greater than or equal to <LEVEL> is reported.
-
UPORNCMPL — Up Or Not Complete. Only PM data for the specified MONTYPE that is greater than or equal to the value of <LEVEL>, or that does not have a VLDTY flag of CMPL, is reported.
The default value is UP. The format of MONLEV is Level and Direction.
The TL1 value for the MONLEV parameter is the combination of the Monitor Level and Monitor Direction. For example, the MONLEV value for the Monitor Level "3" and Direction "DN" is "3-DN". This means only the PM data that is less than or equal to 3 will be reported. |
rtrv-tmplspmtuseg:monlev=(level-direction) |
Monitor Period |
The parameter specifies the accumulation time period for the retrieved PM information. Valid values:
-
ALL
-
15-MIN (Default)
-
1-DAY |
rtrv-tmplspmtuseg:tmper |
Monitor Date |
This parameter specifies the starting date of the PM collection period for which PM data is to be reported. The date format is MM-DD (for example: 12-03). The default value is current day. If TMPER=15-MIN, then the date and time specified by MONDAT and MONTM shall be within the previous 8 hours of the current time. If TMPER of 1-DAY, then the date and time specified by MONDAT and MONTM shall be within the previous 7 days of the current date. |
rtrv-tmplspmtuseg:mondat |
Monitor Time |
The parameter specifies the starting time of the PM collection period for which PM data is to be reported. It applies only If TMPER=15-MIN or TMPER=ALL. The time format is HH-MM. The default value is current hour and beginning of the current 15-minute window. If TMPER=15-MIN, then the date and time specified by MONDAT and MONTM shall be within the previous 8 hours of the current time. If TMPER=1-DAY, then the date and time specified by MONDAT and MONTM shall be within the previous 7 days of the current date. [D] The minutes {00-14}, {15-29}, {30-44}, or {45- 59} specifies the first, second, third and fourth 15-minute period within the specified hour. |
rtrv-tmplspmtuseg:montim |
Number of Previous 15- MIN Period |
The field does not apply if the Monitor Period is 1-Day (TMPER=1-DAY). The number of historical register of 15-min. It specifies the number of previous 15-minute historical PM registers to retrieve in addition to that specified by MONDAT and MONTM. The register specified with MONDAT and MONTM will be the first output followed by the NUMMIN previous registers. Valid values:
The default is 1. |
rtrv-tmplspmtuseg:nummin |
Number of Previous 1-Day Period |
The number of 1-day historical registers. It specifies the number of previous 1-day historical PM registers to retrieve in addition to that specified by MONDAT and MONTM. The register specified with MONDAT and MONTM will be the first output followed by the NUMDAY previous registers. Valid values:
|
rtrv-tmplspmtuseg:numday |
PM Reporting |
Tunnel Segment |
The Tunnel Segment AID (e.g. TUSEG-1-1-{1-750}). This is a drop-down list containing all Tunnel Segments in the system. |
rtrv-tmplspm-tuseg:AID |
PM State |
PM State for the selected Tunnel Segment. Valid values:
-
ON
PM collection for all MONTYPE is enabled, PM counters are reset. Current data and History data are retrievable.
-
OFF
PM collection for all MONTYPE is disabled. Current data and History data are retrievable.
-
DISABLED
PM collection for all MONTYPE is disabled. Current data and History data are not retrievable. |
rtrv-tmplspm-tuseg: pmstate |
Monitor Type |
Monitored counters type. Valid values:
-
MINP (MPLS Incoming Number of Packets)
-
MINB (MPLS Incoming Number of Bytes)
-
MONP (MPLS Outgoing Number of Packets)
-
MONB (MPLS Outgoing Number of Bytes |
rtrv-tmplspm-tuseg: montype |
Value |
The measured value of the monitored parameter reported. It is an integer in the range of 0- 18446744073709551615 or "NA". |
rtrv-tmplspm-tuseg: monval |
Validity |
The validity indicator for monitored data. Valid values:
-
ADJ - Data has been manually initialized to 0 (zero) value.
-
COMPL - Data has been accumulated over the entire period.
-
LONG - Data is accumulated over a period greater than the indicated time.
-
NA - Not Available, the data is not available for the entire period (e.g., Module failed, Module being reset etc.).
-
OFF - Off, PM collection has been disabled during the entire period.
-
PRTL - Partial, the data was accumulated over some portion of the time period, but not the entire period (e.g., Module failed, cold-start of the module during accumulation period). |
rtrv-tmplspm-tuseg:vldty |
Time Period |
The accumulation time period for performance monitoring data (1-day or 15-minute collection register). Valid values
|
rtrv-tmplspm-tuseg: tmper |
Date |
The date {01-12} - {01-31} when the PM collection period began. |
rtrv-tmplspm-tuseg: mondat |
Time |
The time of day {00-23} - {00-59} when the PM collection period began. |
rtrv-tmplspm-tuseg: montm |