PatternAssignedHistogramConfig Object

Description:

Analyzer histogram config with assigned pattern.

Writable Attributes
Read-Only Attributes

Parents: GroupHistogram

PatternAssignedHistogramConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

CalibrateTimeSec

Amount of time to auto calibrate scaling.

Type: u32

Default: 30

Range: 5 - 300

CalibrationFrameCountThreshold

Minimum number of frames that must be received during calibration.

Type: u64

Default: 20

Range: 1 - 0xFFFFFFFFFFFFFFFF

HistMode

Counter and measurement to be used when updating histogram buckets.

Type: enum

Default: LATENCY

Possible Values:

Value	Description
INTERARRIVALTIME	Group histogram mode is inter-arrival time.
LATENCY	Group histogram mode is latency.
FRAMELENGTH	Group histogram mode is framelength.
JITTER	Group histogram mode is jitter.

MaxCalibrationMeasurementInput

A value that will be use to override the systems maximum calibration value.

Type: double

Default: 0

MeasurementDisplayUnits

Group histogram measurement display units.

Type: enum

Default: MICROSECONDS

Possible Values:

Value	Description
TEN_NANOSECONDS	Group histogram measurement display unit is 10 nanoseconds.
MICROSECONDS	Group histogram measurement display unit is microseconds.
MILLISECONDS	Group histogram measurement display unit is milliseconds.
SECONDS	Group histogram measurement display unit is seconds.
NONE	No group histogram measurement display unit.

MinCalibrationMeasurementInput

A value that will be use to override the systems minimum calibration value.

Type: double

Default: 0

PatternMode

The predefined pattern mode to use.

Type: enum

Default: TOS

Possible Values:

Value	Description
TOS	Predefined pattern mode is IP TOS.
TOS_PRECEDENCE	Predefined pattern mode is IP TOS Precedence.
MPLS_PRIORITY	Predefined pattern mode is MPLS priority.
VLAN_PRIORITY	Predefined pattern mode is VLAN priority.

UseMaxCalibrationMeasurementInput

Override the systems maximum calibration value.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable to override the systems maximum calibration value.
FALSE	Disable to not override the systems maximum calibration value.

UseMinCalibrationMeasurementInput

Override the systems minimum calibration value.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable to override the systems minimum calibration value.
FALSE	Disable to not override the systems minimum calibration value.

PatternAssignedHistogramConfig Read-Only Attributes

Read-Only Attribute

Description

HaveCalibrated

Indicate if an auto calibaration has been executed.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	An auto calibration is executed.
FALSE	Calibration is not executed.

MeasurementBucketNames

List of measurement bucket names. The list is empty if a calibration has not been executed.

Type: string

Default: "" (empty string)

MeasurementBucketSize

Size of a histogram bucket in the configured display units.

Type: string

Default: "" (empty string)

PortsStatus

Overall status for the ports enabled for histogram processing.

Type: enum

Default: STOPPED

Possible Values:

Value	Description
CONFIGURING	A configuration is sending to the port.
CONFIGURED	The port has been successfully configured.
CONFIGURATION_WARNING	Used as an overall status. Some ports could be configured, but not all configuration were successful.
CONFIGURATION_ERROR	An error has occurred during configuration.
STARTING	In the process of transitioning to a state of updating port histogram buckets.
STARTED	Port histogram buckets have been succesfully updated.
START_WARNING	Used as an overall status. Some ports could be started, but not all start were successful.
START_ERROR	An error occurred when starting the update of port histogram buckets.
CALIBRATING	In the process of calibrating.
CALIBRATED	Calibration is completed successfully.
CALIBRATION_WARNING	Used as an overall status. Some ports could be calibrated, but not all calibration were successful.
CALIBRATION_ERROR	An error occurred during calibration.
STOPPING	In the process of transitioning to a state where port histogram buckets are no longer updated.
STOPPED	Updating group histogram buckets are stopped.
STOP_WARNING	Used as an overall status. Some ports could be stop, but not all stop were successful.
STOP_ERROR	An error occurred when stopping the updating of port histogram buckets.

PortsStatusDescription

Overall ports status description.

Type: string

Default: "" (empty string)