filterPallette

filterPallette - configure the filter palettes of a port on a card on a chassis.

SYNOPSIS

filterPallette sub-command options

DESCRIPTION

The filterPallette command is used to configure the information that the receiving frames are going to be filtered on. This palette applies to all the filters (capture trigger, capture filter, user defined statistics 1 and 2) that are enabled by the filter command.

When the setting for filter captureFilterError is set to errGfpErrors, the enableGfptHecError, enableGfpeHecError, enableGfpPayloadCrcError and enableGfpBadFcsError determine which GFP errors are used. The setting of gfpErrorCondition is used to determine if the OR or AND of these conditions are desired.

For ports that support the portFeaturePatternOffsetFlexible feature, it is possible to specify the pattern offsets relative to the start of frame, start of IP frame, start of interior protocol or start of SONET frame.

STANDARD OPTIONS
circuitList

Configure the list of circuits that would apply to filters. (string)

enableGfpBadFcsError true | false

If true, then GFP bad FCS errors are used in the filter. This condition is OR'd or AND'd with the other GFP errors based on the setting of the gfpErrorCondition option. (default = true)

enableGfpeHecError true | false

If true, then GFP extension header HEC errors are used in the filter. This condition is OR'd or AND'd with the other GFP errors based on the setting of the gfpErrorCondition option. (default = true)

enableGfpPayloadCrc

Error true | false

If true, then GFP payload CRC errors are used in the filter. This condition is OR'd or AND'd with the other GFP errors based on the setting of the gfpErrorCondition option. (default = true)

enableGfptHecError true | false

If true, then GFP type header HEC errors are used in the filter. This condition is OR'd or AND'd with the other GFP errors based on the setting of the gfpErrorCondition option. (default = true)

DA1

Only frames that contain this destination MAC address are filtered, captured or counted. (default = 00 00 00 00 00 00)

DA2

Only frames that contain this destination MAC address are filtered, captured or counted. (default = 00 00 00 00 00 00)

DAMask1

A bit mask that allows to specify which bits of the DA1 should be used when filtering. If the mask bit is set high, the pattern bit is used in the filter. (default = 00 00 00 00 00 00)

DAMask2

A bit mask that allows to specify which bits of the DA2 should be used when filtering. If the mask bit is set high, the pattern bit is used in the filter. (default = 00 00 00 00 00 00)

gfpErrorCondition

Indicates whether the enabled error conditions associated with enableGfptHecError, enableGfpeHecError, enableGfpPayloadCrcError and enableGfpBadFcsError must all be present (AND'd) or only one must be present (OR).

Option

Value

Usage

gfpErrorsOr

0

(default) Only one of the enabled error conditions must be present.

gfpErrorsAnd

1

All of the enabled error conditions must be present.

matchType1

Match type for pattern1 set in class member pattern1. The available match types are:

Option

Value

Usage

matchIpEthernetII

0

anEthernet II packet.

matchIp8023Snap

1

an802.3 SNAP packet.

matchVlan

2

a VLAN tagged packet.

matchUser

3

(default) a value as specified by pattern1, pattern Mask1 and patternOffset1.

matchIpPpp

4

a PPP format packet

matchIpCiscoHdlc

5

a Cisco HDLC format packet.

matchIpSAEthernetII

6

match the IP Source Address for an Ethernet II packet located at offset 26.

matchIpDAEthernetII

7

match the IP Destination Address for an Ethernet II packet located at offset 30.

matchIpSADAEthernetII

8

match the IP Source and Destination Address for an Ethernet II packet located at offset 26.

matchIpSA8023Snap

9

match the IP Source Address for an 802.3 Snap packet located at offset 34.

matchIpDA8023Snap

10

match the IP Destination Address for an 802.3 Snap packet located at offset 38.

matchIpSADA8023Snap

11

match the IP Source and Destination Address for an 802.3 Snap packet located at offset 34.

matchIpSAPos

12

match the IP Source Address for an POS packet located at offset 16.

matchIpDAPos

13

match the IP Destination Address for an POS packet located at offset 20.

matchIpSADAPos

14

match the IP Source and Destination Addresses for an POS packet located at offset 16.

matchTcpSourcePortIPEthernetII

15

match the TCP Source Port for an Ethernet II packet located at offset 34.

matchTcpDestPortIPEthernetII

16

match the TCP Destination Port for an Ethernet II packet located at offset 36.

matchUdpSourcePortIPEthernetII

17

match the UDP Source Port for an Ethernet II packet located at offset 34.

matchIpSAPos

12

match the IP Source Address for an POS packet located at offset 16.

matchIpDAPos

13

match the IP Destination Address for an POS packet located at offset 20.

matchIpSADAPos

14

match the IP Source and Destination Addresses for an POS packet located at offset 16.

matchTcpSourcePortIPEthernetII

15

match the TCP Source Port for an Ethernet II packet located at offset 34.

matchTcpDestPortIPEthernetII

16

match the TCP Destination Port for an Ethernet II packet located at offset 36.

matchUdpSourcePortIPEthernetII

17

match the UDP Source Port for an Ethernet II packet located at offset 34.

matchUdpDestPortIPEthernetII

18

match the UDP Destination Port for an Ethernet II packet located at offset 36.

matchTcpSourcePortIP8023Snap

19

match the TCP Source Port for an 802.3 Snap packet located at offset 42.

matchTcpDestPortIP8023Snap

20

match the TCP Destination Port for an 802.3 Snap packet located at offset 44.

matchUdpSourcePortIP8023Snap

21

match the UDP Source Port for an 802.3 Snap packet located at offset 42.

matchUdpDestPortIP8023Snap

(22)

match the UDP Destination Port for an 802.3 Snap packet located at offset 44

matchTcpSourcePortIPPos

23

match the TCP Source Port for a POS packet located at offset 24.

matchTcpDestPortIPPos

24

match the TCP Destination Port for a POS packet located at offset 26.

matchUdpSourcePortIPPos

25

match the UDPSource Port for a POS packet located at offset 24.

matchUdpDestPortIPPos

26

match the UDP Source Port for a POS packet located at offset 26

matchSrpModeReserved000

27

match an SRP packet whose mode is reserved 000.

matchSrpModeReserved001

28

match an SRP packet whose mode is reserved 001.

matchSrpModeReserved010

29

match an SRP packet whose mode is reserved 010.

matchSrpModeAtmCell011

30

match an SRP packet whose mode is ATM cell.

matchSrpControlMessagePassToHost100

31

match an SRP packet whose mode is control message 1.

matchSrpControlMessageBuffer

ForHost101

32

match an SRP packet whose mode is control message 2.

matchSrpUsageMessage110

33

match an SRP packet which is an SRP usage message.

matchSrpPacketData111

34

match an SRP packet which is a data packet.

matchSrpAllControlMessages10x

35

match SRP control messages 1 and 2.

matchSrpUsageMessageOr

PacketData11x

36

match SRP usage message or data packet.

matchSrpControlUsageOr

PacketData1xx

37

match SRP usage message, control message 1 or 2, or data packet.

matchSrpInnerRing

38

match an SRP packet whose ringIdentifier is set to inner.

matchSrpOuterRing

39

match an SRP packet whose ringIdentifier is set to outer.

matchSrpPriority0-7

40-47

match an SRP packet whose priority is set to 0 - 7.

matchSrpParityOdd

48

match an SRP packet with odd parity.

matchSrpParityEven

49

match an SRP packet with even parity.

matchSrpDiscoveryFrame

50

match an SRP discovery packet.

matchSrpIpsFrame

51

match an SRP IPS packet.

matchRprRingId0

52

 

Match any RPR packet which specifies Ringlet 0. (Originally transmitted on Ringlet 0 by the Source)

matchRprRingId1

53

 

Match any RPR packet which specifies Ringlet 1. (Originally transmitted on Ringlet 1 by the Source)

matchRprFairnessEligibility0

54

Match any RPR packet which specifies Fairness Eligibility 0. (0 = Not eligible for Fairness algorithm)

matchRprFairnessEligibility1

55

Match any RPR packet which specifies Fairness Eligibility 1. (0 = Not eligible for Fairness algorithm)

matchRprIdlePacket

56

Match any RPR Idle packet (Type = 00).

matchRprControlPacket

57

Match any RPR Control packet. (Type = 01)

matchRprFairnessPacket

58

Match any RPR Fairness packet. (Type = 10)

matchRprDataPacket

59

Match any RPR Data packet. (Type = 11)

matchRprServiceClassC

60

Match any RPR packet which specifies service Class C.

matchRprServiceClassB

61

Match any RPR packet which specifies service Class B.

matchRprServiceClassA1

62

Match any RPR packet which specifies service Class A1.

matchRprServiceClassA0

63

Match any RPR packet which specifies service Class A0.

matchRprWrapEligibility0\

64

Match any RPR packet which specifies Wrap Eligibility 0. (0 = Steerable only)

matchRprWrapEligibility1

65

Match any RPR packet which specifies Wrap Eligibility 1. (1 = Wrap Eligible)

matchRprParityBit0

66

Match any RPR packet which specifies Parity Bit 0.

matchRprParityBit1

67

Match any RPR packet which specifies Parity Bit 1.

matchIpV6SAEthernetII

68

Match the IPv6 Source Address for an Ethernet II packet.

matchIpV6DAEthernetII

69

Match the IPv6 Destination Address for an Ethernet II packet.

matchIpV6SA8023Snap

70

Match the IPv6 Source Address for an 802.3 packet.

matchIpV6DA8023Snap

71

Match the IPv6 Destination Address for an 802.3 packet.

matchIpV6SAPos

72

Match the IPv6 Source Address for a POS packet.

matchIpV6DAPos

73

Match the IPv6 Destination Address for a POS packet.

matchIpv6TcpSourcePort

EthernetII

74

Match the IPv6 TCP source port number for an Ethernet II packet.

matchIpv6TcpDestPortEthernetII

75

Match the IPv6 TCP destination port number for an Ethernet II packet.

matchIpv6UdpSourcePort

EthernetII

76

Match the IPv6 UDP source port number for an Ethernet II packet.

matchIpv6UdpDestPortEthernetII

77

Match the IPv6 UDP destination port number for an Ethernet II packet.

matchIpv6TcpSourcePort

8023Snap

78

Match the IPv6 TCP source port number for an 802.3 SNAP packet.

matchIpv6TcpDestPort8023Snap

79

Match the IPv6 TCP destination port number for an 802.3 Snap packet.

matchIpv6UdpSourcePort

8023Snap

80

Match the IPv6 UDP source port number for an 802.3 Snap packet.

matchIpv6UdpDestPort8023Snap

81

Match the IPv6 UDP destination port number for an 802.3 Snap packet.

matchIpv6TcpSourcePortPos

82

Match the IPv6 TCP source port number for an pos packet.

matchIpv6TcpDestPortPos

83

Match the IPv6 TCP destination port number for an pos packet.

matchIpv6UdpSurcePortPos

84

Match the IPv6 UDP source port number for an pos packet.

matchIpv6UdpDestPortPos

85

Match the IPv6 UDP destination port number for an pos packet.

matchIpv6IpTcpSourcePort

EthernetII

86

Match the TCP source port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in an Ethernet II packet.

matchIpv6IpTcpDestPort

EthernetII

87

Match the TCP destination port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in an Ethernet II packet.

matchIpv6IpUdpSourcePort

EthernetII

88

Match the UDP source port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in an Ethernet II packet.

matchIpv6IpUdpDestPort

EthernetII

89

Match the UPD destination port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in an Ethernet II packet.

matchIpv6IpTcpSourcePort

8023Snap

90

Match the TCP source port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in an 802.3 Snap packet.

matchIpv6IpTcpDestPort8023

Snap

91

Match the TCP destination port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in an 802.3 Snap packet.

matchIpv6IpUdpSourcePort

8023Snap

92

Match the UDP source port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in an 802.3 Snap packet.

matchIpv6IpUdpDestPort8023

Snap

93

Match the UPD destination port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in an 802.3 Snap packet.

matchIpv6IpTcpSourcePortPos

94

Match the TCP source port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in a POS packet.

matchIpv6IpTcpDestPortPos

95

Match the TCP destination port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in a POS packet.

matchIpv6IpUdpSourcePortPos

96

Match the UDP source port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in a POS packet.

matchIpv6IpUdpDestPortPos

97

Match the UPD destination port number for an IPv4 over IPv6 or IPv6 over IPv4 frame in a POS packet.

matchIpOverIpv6IpSAEthernetII

98

Match the IPv4 source address in an IPv4 frame encapsulated in an IPv6 frame in an Ethernet II packet.

matchIpOverIpv6IpDAEthernetII

99

Match the IPv4 destination address in an IPv4 frame encapsulated in an IPv6 frame in an Ethernet II packet.

matchIpOverIpv6IpSA8023Snap

100

Match the IPv4 source address in an IPv4 frame encapsulated in an IPv6 frame in an 802.3 Snap packet.

matchIpOverIpv6IpDA8023Snap

101

Match the IPv4 destination address in an IPv4 frame encapsulated in an IPv6 frame in an 802.3 Snap packet.

matchIpOverIpv6IpSAPos

102

Match the IPv4 source address in an IPv4 frame encapsulated in an IPv6 frame in POS packet.

matchIpOverIpv6IpDAPos

103

Match the IPv4 destination address in an IPv4 frame encapsulated in an IPv6 frame in POS packet.

matchIpv6OverIpIpv6SA

EthernetII

104

Match the IPv6 source address in an IPv6 frame encapsulated in an IPv4 frame in an Ethernet II packet.

matchIpv6OverIpIpv6DA

EthernetII

105

Match the IPv6 destination address in an IPv6 frame encapsulated in an IPv4 frame in an Ethernet II packet.

matchIpv6OverIpIpv6SA8023

Snap

106

Match the IPv6 source address in an IPv6 frame encapsulated in an IPv4 frame in an 802.3 Snap packet.

matchIpv6OverIpIpv6DA8023

Snap

107

Match the IPv6 destination address in an IPv6 frame encapsulated in an IPv4 frame in an 802.3 Snap packet.

matchIpv6OverIpIpv6SAPos

108

Match the IPv6 source address in an IPv6 frame encapsulated in an IPv4 frame in POS packet.

matchIpv6OverIpIpv6DAPos

109

Match the IPv6 destination address in an IPv6 frame encapsulated in an IPv4 frame in POS packet.

matchIpv6Ppp

110

Match an IPv6 PPP packet.

matchIpv6CiscoHdlc

111

Match an IPv6 packet encapsulated with Cisco HDLC.

matchGfpDataFcsNullExtEthernet

112

Match a user data GFP frame which includes an FCS and whose payload uses a null extension and indicates frame-mapped ethernet data.

matchGfpDataNoFcsNullExtEthernet

113

Match a user data GFP frame which does not includes an FCS and whose payload uses a null extension and indicates frame-mapped ethernet data.

matchGfpDataFcsLinearExtEthernet

114

Match a user data GFP frame which includes an FCS and whose payload uses a linear frame extension and indicates frame-mapped ethernet data.

matchGfpDataNoFcsLinearExtEthernet

115

Match a user data GFP frame which does not includes an FCS and whose payload uses a linear frame extension and indicates frame-mapped ethernet data.

matchGfpMgmtFcsNullExtEthernet

116

Match a management GFP frame which includes an FCS and whose payload uses a null extension and indicates frame-mapped ethernet data.

matchGfpMgmtNoFcsNullExtEthernet

117

Match a management GFP frame which does not includes an FCS and whose payload uses a null extension and indicates frame-mapped ethernet data.

matchGfpMgmtFcsLinearExtEthernet

118

Match a management GFP frame which includes an FCS and whose payload uses a linear frame extension and indicates frame-mapped ethernet data.

matchGfpMgmtNoFcsLinearExt

Ethernet

119

Match a management GFP frame which does not includes an FCS and whose payload uses a linear frame extension and indicates frame-mapped ethernet data.

matchGfpDataFcsNullExtPpp

120

Match a user data GFP frame which includes an FCS and whose payload uses a null extension and indicates frame-mapped PPP data.

matchGfpDataNoFcsNullExtPpp

121

Match a user data GFP frame which does not includes an FCS and whose payload uses a null extension and indicates frame-mapped PPP data.

matchGfpDataFcsLinearExtPpp

122

Match a user data GFP frame which includes an FCS and whose payload uses a linear frame extension and indicates frame-mapped PPP data.

matchGfpDataNoFcsLinearExtPpp

123

Match a user data GFP frame which does not includes an FCS and whose payload uses a linear frame extension and indicates frame-mapped PPP data.

matchGfpMgmtFcsNullExtPpp

124

Match a management GFP frame which includes an FCS and whose payload uses a null extension and indicates frame-mapped PPP data.

matchGfpMgmtNoFcsNullExtPpp

125

Match a management GFP frame which does not includes an FCS and whose payload uses a null extension and indicates frame-mapped PPP data.

matchGfpMgmtFcsLinearExtPpp

126

Match a management GFP frame which includes an FCS and whose payload uses a linear frame extension and indicates frame-mapped PPP data.

matchGfpMgmtNoFcsLinearExtPpp

127

Match a management GFP frame which does not includes an FCS and whose payload uses a linear frame extension and indicates frame-mapped PPP data.

matchType2

Match type for pattern2. The available match types are as in matchType1. (default = 3)

pattern1

Only frames that contain this pattern at offset patternOffset1 are filtered, captured or counted. (default = "DE ED EF FE AC CA")

Note: Starting with IxOS 5.0, the hex string must be separated by a space between the hex bytes, for example: '00 80'.

pattern2

Only frames that contain this pattern at offset patternOffset2 are filtered, captured or counted. (default = 00)

patternMask1

A bit mask that allows to specify which bits of pattern1 should be used when filtering. If the mask bit is set low, the pattern bit is used in the filter. (default = 00 00 00 00 00 00)

patternMask2

A bit mask that allows to specify which bits of pattern2 should be used when filtering. If the mask bit is set low, the pattern bit is used in the filter. (default = 00)

patternOffset1

Offset of pattern1 in the frame to be filtered, captured or counted. (default = 12)

patternOffset2

Offset of pattern2 in the frame to be filtered, captured or counted. (default = 12)

patternOffsetType1

For ports that support the portFeaturePatternOffsetFlexible feature, this option specifies the place that patternOffset1 is relative to. This value must be one of these options:

Option

Usage

filterPalletteOffsetStartOfFrame

(default) Offset from the start of the frame.

filterPalletteOffsetStartOfIp

Offset from the start of the IP header

filterPalletteOffsetStartOfProtocol

Offset from the start of the protocol within the IP header.

filterPalletteOffsetStartOfSonet

Offset from the start of the SONET frame.

patternOffsetType2

For ports that support the portFeaturePatternOffsetFlexible feature, this option specifies the place that patternOffset1 is relative to. See patternOffset

SA1

Only frames that contain this source MAC address are filtered, captured or counted. (default = 00 00 00 00 00 00)

SA2

Only frames that contain this source MAC address are filtered, captured or counted. (default = 00 00 00 00 00 00)

SAMask1

A bit mask that allows to specify which bits of the SA1 should be used when filtering. If the mask bit is set high, the pattern bit is used in the filter. (default = 00 00 00 00 00 00)

SAMask2

A bit mask that allows to specify which bits of the SA2 should be used when filtering. If the mask bit is set high, the pattern bit is used in the filter. (default = 00 00 00 00 00 00)

COMMANDS

The filterPallette command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.

filterPallette cget option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the filterPallette command.

filterPallette config option value

Modify the configuration options of the filterPallette. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for filterPallette.

Note: Must be a valid Tcl list (values must be separated by spaces).

filterPallette get chasID cardID portID

Gets the current config of the filterPallette on port portID on card cardID, chassis chasID. from its hardware. Call this command before calling filterPallette cget option value to get the value of the configuration option. Specific errors are:

filterPallette set chasID cardID portID

Sets the configuration of the filterPallette in IxHAL on port with id portID on card cardID, chassis chasID by reading the configuration option values set by the filterPallette config option value command. Specific errors are:

filterPallette set chasID cardID portID

Sets the configuration of the local port filterPallette object in IxHAL for port with id portID on card cardID, chassis chasID. Specific errors are:

filterPallette setDefault

Sets to IxTclHal default values for all configuration options.

filterPallette write chasID cardID portID

Writes or commits the changes in IxHAL to hardware for the filter palette on port with id portID on card cardID, chassis chasID. Before using this command, use the filterPallette set command to configure the filterPallette related parameters in IxHAL. Specific errors are:

EXAMPLES

See examples under filter.

SEE ALSO

filter.