Y.1564 test profile commands

test-oam

Syntax

test-oam

Context

config

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure Operations, Administration, and Maintenance test parameters

testhead-profile

Syntax

testhead-profile profile-num [create]

no testhead-profile profile-num

Context

config>test-oam

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command creates service testhead profiles which are used by the Y.1564/RFC 2544 testhead (also known as traffic generator) OAM tool. A service testhead profile makes it possible to configure parameters such as the contents of the frame payload that is generated by traffic generator, the size of the frame, test duration, test acceptance criteria, and other criteria to be used by the testhead tool.

The profile is used by the testhead OAM tool to generate the appropriate frame at the configured rate and measure performance parameters such as frame delay (FD), frame delay variation (FDV), and loss. At the end of the test run, the tool compares the measured values against the test acceptance criteria that are configured in the profile to determine if the service is within bounds of the acceptance criteria or not.

The no form the command removes configured profile from the system.

Parameters

profile-id

Identifies the profile.

Values

1 to 10

acceptance-criteria

Syntax

acceptance-criteria acceptance-criteria-id [create]

no acceptance-criteria acceptance-criteria-id

Context

configure>test-oam>testhead-profile

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command specifies the test acceptance criteria to be used by the testhead OAM tool for declaring the PASS/FAIL result at the completion of the test.

It is possible to create up to 4 different acceptance criteria per profile to measure different SLA needs. Users can optionally specify only one acceptance criterion to be used by the testhead OAM tool during the invocation of the test.

The no form of this command removes the test acceptance criteria.

Default

no defaults

Parameters

acceptance-criteria-id

Specifies a number to identify the test acceptance criteria. It is a decimal number used to identify the test acceptance criteria and to use when starting the throughput test.

Values

1 to 4

cir-threshold

Syntax

cir-threshold cir-threshold

no cir-threshold

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a CIR value that is compared to the measured CIR at the end of the test in order to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛PASS’; otherwise, it is considered to be ‛FAIL’.

The no form of this command disables the comparison of the parameter with the measured value at the end of the test. Basically, the threshold value is ignored and not considered for declaring the test result.

Default

no cir-threshold

Parameters

threshold

Specifies the value for comparison with the measured value.

Values

0 to 1000000 kbps

jitter-rising-threshold

Syntax

jitter-rising-threshold threshold

no jitter-rising-threshold

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a jitter value that is compared to the measured jitter at the end of the test in order to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛FAIL’; otherwise, it is considered to be ‛PASS’.

The no form of this command disables the comparison of the parameter with the measured value so that the threshold value is ignored for declaring the test result.

Default

no jitter-rising-threshold

Parameters

threshold

Specifies the value for comparison with measured value.

Values

0 to 2147483000, in microseconds

jitter-rising-threshold-in

Syntax

jitter-rising-threshold-in threshold

no jitter-rising-threshold-in

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a jitter value that is compared to the measured jitter for green/in-profile packets at the end of the test to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛FAIL’; otherwise, it is considered to be ‛PASS’.

The no form of this command disables the comparison of the parameter with the measured value at the end of the test. Basically, the threshold value is ignored and not considered for declaring the test result.

Default

no jitter-rising-threshold-in

Parameters

In-profile-threshold

Specifies the value, in microseconds, for comparison with the measured value.

Values

0 to 2147483000

jitter-rising-threshold-out

Syntax

[no] jitter-rising-threshold-out out-profile-threshold

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a jitter value that is compared to the measured jitter for yellow/out-of-profile packets at the end of the test to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛FAIL’; otherwise, it is considered to be ‛PASS’.

The no form of this command disables the comparison of the parameter with the measured value so that the threshold value is ignored for declaring the test result.

Default

no jitter-rising-threshold-out

Parameters

out-profile-threshold

Specifies the value, in microseconds, for comparison with the measured value.

Values

0 to 2147483000

latency-rising-threshold

Syntax

latency-rising-threshold threshold

no latency-rising-threshold

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a latency value that is compared to the measured latency at the end of the test to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛FAIL’; otherwise, it is considered to be ‛PASS’.

The no form of this command disables the comparison of the parameter with the measured value so that the threshold value is ignored for declaring the test result.

Default

no latency-rising-threshold

Parameters

threshold

Specifies the value, in microseconds, for comparison with the measured value.

Values

0 to 2147483000

latency-rising-threshold-in

Syntax

latency-rising-threshold-in threshold

no latency-rising-threshold-in

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a latency value that is compared to the measured latency for green/in-profile packets at the end of the test to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛FAIL’; otherwise, it is considered to be ‛PASS’.

The no form of this command disables the comparison of the parameter with the measured value so that the threshold value is ignored for declaring the test result.

Default

no latency-rising-threshold-in

Parameters

In-profile-threshold

Specifies the value, in microseconds, for comparison with the measured value.

Values

0 to 2147483000

latency-rising-threshold-out

Syntax

latency-rising-threshold-out threshold

no latency-rising-threshold-out

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a latency value that is compared to the measured latency of yellow or out-of-profile packets at the end of the test to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛FAIL’; otherwise, it is considered to be ‛PASS’.

The no form of this command disables the comparison of the parameter with the measured value so that the threshold value is ignored for declaring the test result.

Default

no latency-rising-threshold-out

Parameters

out-profile-threshold

Specifies the value, in microseconds, for comparison with the measured value.

Values

0 to 2147483000

loss-rising-threshold

Syntax

loss-rising-threshold threshold

no loss-rising-threshold

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a frame loss ratio (FLR) value that is compared to the measured FLR at the end of the test to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛FAIL’; otherwise, it is considered to be ‛PASS’.

The FLR is computed as a ratio of the difference of the number of received frames to the number of injected or sent frames divided by the number of sent frames.

The no form of this command disables the comparison of the parameter with the measured value so that the threshold value is ignored for declaring the test result.

Default

no loss-rising-threshold

Parameters

threshold

Specifies the value for comparison with the measured value, specified as a number which denotes one ten-thousandth (1/10000) of a percent. For example, specifying a value of 1 is equivalent to 0.0001%, and specifying a value of 10000 is equivalent to 1%.

Values

1 to 1000000

loss-rising-threshold-in

Syntax

loss-rising-threshold-in ithreshold

no loss-rising-threshold-in

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a frame loss ratio (FLR) value that is compared to the measured FLR for green or in-profile packets at the end of the test to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛FAIL’; otherwise, it is considered to be ‛PASS’.

The FLR for green/in-profile packets is computed as a ratio of the difference of the number of received green or in-profile frames to the number of injected/sent green/in-profile frames divided by the number of sent green frames.

The no form of this command disables the comparison of the parameter with the measured value so that the threshold value is ignored for declaring the test result.

Default

no loss-rising-threshold-in

Parameters

in-profile-threshold

Specifies the value for comparison with the measured value, specified as a number which denotes one ten-thousandth (1/10000) of a percent. For example, specifying a value of 1 is equivalent to 0.0001%, and specifying a value of 10000 is equivalent to 1%

Values

1 to 1000000

loss-rising-threshold-out

Syntax

loss-rising-threshold-out threshold

no loss-rising-threshold-out

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the frame loss ratio (FLR) value that is compared to the measured FLR for yellow/out-of-profile packets at the end of the test to declare the test result. If the measured value is greater than the configured value, the test is declared as ‛FAIL’; otherwise, it is considered to be ‛PASS’.

The FLR for yellow/out-of-profile packets is computed as a ratio of the difference of the number of received yellow frames to the number of injected/sent yellow frames divided by the number of sent yellow frames.

The no form of this command disables the comparison of the parameter with the measured value so that the threshold value is ignored for declaring the test result.

Default

no loss-rising-threshold

Parameters

out-profile-threshold

Specifies the value for comparison with the measured value, specified as a number which denotes one ten-thousandth (1/10000) of a percent. For example, specifying a value of 1 is equivalent to 0.0001%, and specifying a value of 10000 is equivalent to 1%.

Values

1 to 1000000

pir-threshold

Syntax

pir-threshold threshold

no pir-threshold

Context

configure>test-oam>testhead-profile>acceptance-criteria

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the PIR value that is compared to the measured PIR at the end of the test to declare the test result. If the measured value is greater than the configured value the test is declared as ‛PASS’; otherwise, it is considered to be ‛FAIL’.

The no form of this command disables the comparison of the parameter with the measured value so that the threshold value is ignored for declaring the test result.

Default

no pir-threshold

Parameters

threshold

Specifies the value, in kbps, for comparison with the measured value.

Values

0 to 1000000

dot1p

Syntax

[no] dot1p in-profile dot1p-value out-of-profile dot1p-value

Context

configure>test-oam>testhead-profile

Platforms

7210 SAS-D, 7210 SAS-Dxp

Description

This command configures the Dot1p values to identify the in-profile or green packets and out-of-profile or yellow packets. The values configured using this command are used by the testhead tool on the local end (that is, the node on which the testhead tool is executed) to match the dot1p values received in the packet header and identify green and yellow packets and appropriately account the packets. These values are used only when the testhead tool is invoked with the parameter color-aware is set to enable.

The dot1p in-profile value (that is, packets with dot1p values in the L2 header equal to the dot1p-in-profile value configured is considered to be in-profile or green packet) is used to count the number of in-profile packets and measure the latency, jitter, and FLR for in-profile packets. Similarly, the dot1p out-profile is used to count the total out-of-profile or yellow packets and measure latency, jitter, and FLR for out-of-profile or yellow packets.

While the testhead tool is initiated, if color-aware is set to enable and no values are specified (that is, the no form of this command is used in the profile), the CLI gives an error. If values are specified, the configured values are used to match and identify in-profile and out-of-profile packets.

The no form of this command disables the use of dot1p to identify a green or yellow packet.

Note:

Testhead OAM tool does not mark the packets below CIR as in-profile packets and packets above CIR and below PIR as out-of-profile packets using the Dot1p or DSCP or other packet header bits to indicate the color of the packet (for example: DEI bit), as the 7210 SAS access SAP ingress does not support color-aware metering. It is used to only identify green and yellow packets and maintain a count of received green and yellow packets when the tests are run in color-aware mode.

Default

The no form of this command is the default. There are no defaults for the dot1p values.

Parameters

in-profile dot1p-value

Specifies the dot1p value used to identify green or in-profile packets. It must be different than the value configured for yellow or out-of-profile packets.

Values

0 to 7

out-profile dot1p-value

Specifies the dot1p value used to identify green or out-of-profile packets. It must be different than the value configured for green or in-profile packets.

Values

0 to 7

description

Syntax

description description-string

no description

Context

config>test-oam>testhead-profile

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures a description for a testhead profile.

The no form the command removes the description.

Parameters

description-string

Specifies the description for the testhead profile.

Values

ASCII string

frame-payload

Syntax

frame-payload frame-payload-id [payload-type [l2 | tcp-ipv4 | udp-ipv4 | ipv4] [create]

no frame-payload frame-payload

Context

configure>test-oam>testhead-profile

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command specifies the packet header values to be used in frames generated by testhead tool.

One of 4 types of frame payload, representing different kinds of traffic, can be selected within a profile. The user chooses one among these when starting the throughput test.

The payload-type parameter determines the packet header fields that are used to populate the frame generated by the testhead OAM tool. The packet header fields use the parameters configured under the frame-payload. For example, when the payload-type is configured as l2, software uses the parameters src-mac, dst-mac, vlan-tag-1 (if configured), vlan-tag-2 (if configured), ethertype, and data-pattern. See below for parameters used when other values are specified with payload-type.

The no form of this command removes the frame payload context.

Parameters

frame-payload-id

Identifies the frame payload, it is an integer used to identify the frame type to use when starting the throughput test.

Values

1 to 4

frame-payload-type

Identifies whether the frame payload is L2 traffic, IP traffic, TCP/IP traffic or UDP/IP traffic and uses appropriate parameters to build the frame generated by the testhead OAM tool. If no frame payload type value is specified during creation of the new frame payload, the default is tcp-ipv4.

Values

l2 | tcp-ipv4 | udp-ipv4 | ipv4

When l2 is specified, use src-mac+dst-mac+vlan-tag-1 (if available)+vlan-tag-2 (if available)+ethertype+data-pattern.

When tcp-ipv4 or udp-ipv4 is specified, use src-mac+dst-mac+vlan-tag-1(if available)+vlan-tag-2 (if available)+ethertype=0x0800+src-ipv4+dst-ipv4+ip-ttl+ip-dscp or ip-tos+TCP/UDP protocol number+src-port+dst-port+data-pattern.

When ipv4 is specified, use src-mac+dst-mac+vlan-tag-1(if available)+vlan-tag-2 (if available)+ethertype=0x0800+src-ipv4+dst-ipv4+ip-ttl+ip-dscp or ip-tos+ip-proto+data-pattern.

data-pattern

Syntax

data-pattern data-pattern

no data-pattern

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the data pattern to populate the payload portion of the frame generated by the testhead tool.

This value can be specified when the payload-type is configured as l2, ipv4, tcp-ipv4 or udp-ipv4. For all these payload types, the frame with the appropriate headers is created and the payload portion of the frame is filled up with the data pattern value specified with this command, repeating it as many times as required to fill up the remaining length of the payload.

The no form of this command uses the default data pattern value of 0xa1b2c3d4e5f6.

Default

no data-pattern

Parameters

data-pattern

Specifies the data pattern to fill the payload data.

Values

a string of 1 to 64 decimal or hexadecimal numbers

description

Syntax

description frame-description

no description

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command creates a text description for a frame generated by the testhead tool.

The no form of this command removes the description.

Default

no description

Parameters

frame-description

Specifies the ASCII string to describe the frame.

Values

ASCII string

dscp

Syntax

dscp dscp-name

no dscp

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the IP DSCP value to use in the IP header for the frame generated by the testhead tool.

This value can be specified when the payload-type is configured as ipv4, tcp-ipv4, or udp-ipv4. When the payload-type is set to ipv4, tcp-ipv4, or udp-ipv4 but this command is not configured, the DSCP value defaults to 0. The testhead tool does not use the value specified with this command if the payload-type is l2.

Note:

  • If both IP DSCP and IP ToS are configured, IP DSCP take precedence.

  • If IP DSCP is not configured, but IP ToS is configured, the IP ToS value is used

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

no dscp

Parameters

dscp-name

Specifies the IPv4 DSCP value to use in the IP header.

Values

Valid values from the list of DSCP names.

be | ef | cp1 | cp2 | cp3 | cp4 | cp5 | cp6| cp7 | cp9 | cs1 | cs2 | cs3 | cs4 | cs5 | nc1 | nc2 | af11 | af12 | af13 | af21 | af22 | af23 | af31 | af32 | af33 | af41 | af42 |a f43 | cp11 | cp13 | cp15 | cp17 | cp19 | cp21 | cp23 | cp25 | cp27 | cp29 | cp31 | cp33 | cp35 | cp37 | cp39 | cp41 | cp42 | cp43 | cp44 | cp45 | cp47 | cp49 | cp50 | cp51 | cp52 | cp53 | cp54 | cp55 | cp57 | cp58 | cp59 | cp60 | cp61 | cp62 | cp63

dst-ip

Syntax

dst-ip ipv4 ipv4-address

no dst-ip ipv4

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the destination IPv4 address to use in the IP header of the frame generated by the testhead tool.

This value must be specified if the payload-type is configured as ipv4, tcp-ipv4, or udp-ipv4. The testhead tool does not use the value specified with this command if the payload-type is l2.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

no dst-ip ipv4 if the payload-type is set to ipv4, tcp-ipv4 or udp-ipv4

Parameters

ipv4-address

Specifies the IPv4 destination IP address to use in the IP header.

Values

valid IPv4 address specified in dotted-decimal format (that is, a.b.c.d) where a, b, c, d are decimal values in the range 1 to 255

dst-mac

Syntax

dst-mac ieee-address [ieee-address-mask]

no dst-mac

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the destination MAC address to use in the frame generated by the testhead OAM tool. Only unicast MAC address must be specified.

This value must be specified for all possible values of payload-type.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

no dst-mac

Parameters

mac-address

Specifies the unicast destination MAC address for Y1564 packets.

Values

a hexadecimal string using the notation xx:xx:xx:xx:xx:xx. The values for xx can be in the range 0 to 9 and a to f.

dst-port

Syntax

dst-port dst-port-number

no dst-port

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the destination port to use in the TCP header of the frame generated by the testhead tool.

This value must be specified if the payload-type is configured as tcp-ipv4 or udp-ipv4. The testhead tool does not use the value specified with this command if the payload-type is l2 or ipv4.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

no dst-port, if the payload-type is set to tcp-ipv4 or udp-ipv4

Parameters

dst-port-number

Specifies the destination TCP/UDP port number to use in the frame’s TCP/UDP header.

Values

valid TCP/UDP port number specified in decimal or hexadecimal in the range 0 to 65535

ethertype

Syntax

ethertype 0x0600..0xffff

no ethertype

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the Ethertype for the frame generated by the testhead tool.

This value must be specified when the payload-type is l2. The testhead tool uses the value specified with this command only if the payload-type is l2. See the frame-payload command description for information when the payload-type is configured with an option other than l2.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

0x0800

Parameters

0x0600..0xffff

Specifies the Ethertype value as a hexadecimal string in the range 0x0600 to 0xffff.

ip-proto

Syntax

ip-proto ip-protocol-number

no ip-proto

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the IP protocol to use in the IP header of the frame payload generated by the testhead tool.

This value must be specified when the payload-type is configured as ipv4. If the payload-type is configured as tcp-ipv4 or udp-ipv4, the appropriate standard defined values are used. The testhead tool does not use the value specified with this command when the payload-type is l2.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

no ip-proto

Parameters

ip-protocol-number

Specifies the IP protocol number to use in the IP header of Y.1564 packets.

Values

a valid IP protocol number specified as a decimal number in the range 0 to 255

ip-tos

Syntax

ip-tos type-of-service

no ip-tos

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the IP TOS (Type of Service) value to use in the IP header of the frame generated by the testhead tool.

The value can be specified when the payload-type is configured as ipv4, tcp-ipv4, or udp-ipv4. If this command is not configured and the payload-type is set to ipv4, tcp-ipv4, or udp-ipv4, the ToS value defaults to 0. The testhead tool does not use the value specified with this command when the payload-type is l2.

Note:

If both IP DSCP and IP ToS are configured, the IP DSCP value is used. If IP DSCP is not configured but IP ToS is configured, the IP ToS value is used.

The no form of this command indicates that the field is not to be used in the frame generated by the testhead tool.

Default

no ip-tos

Parameters

type-of-service

Specifies ToS bits to use in the IP header.

Values

a valid number in the range 0 to 8

ip-ttl

Syntax

ip-ttl ttl-value

no ip-ttl

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the IP TTL (Time-to-Live) value to use in the IP header of the frame generated by the testhead tool.

This value can be specified if the payload-type is configured as ipv4, tcp-ipv4, or udp-ipv4. If this command is not configured and the payload-type is set to ipv4, tcp-ipv4, or udp-ipv4, the TTL value defaults to 0. The testhead tool does not use the value specified with this command when the payload-type is l2.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

no ip-ttl

Parameters

ttl-value

Specifies the IP TTL value to use in the IP header.

Values

a decimal number in the range 1 to 255

src-ip

Syntax

src-ip ipv4 ipv4-address

no src-ip ipv4

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the source IPv4 address to use in the IP header of the frame generated by the testhead tool.

This value must be specified when the payload-type is configured as ipv4, tcp-ipv4, or udp-ipv4. The testhead tool does not use the value specified with this command when the payload-type is l2.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

no src-ip, if the payload-type is set to ipv4, tcp-ipv4, or udp-ipv4.

Parameters

ipv4-address

Specifies the IPv4 source IP address to use in the IP header.

Values

valid IPv4 address specified in dotted-decimal format (a.b.c.d) where a, b, c, and d are decimal values in the range of 1 to 255

src-mac

Syntax

src-mac ieee-address [ieee-address-mask]

no src-mac

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the source MAC address to use in the frame generated by the testhead OAM tool. Only unicast MAC address must be specified.

This value must be specified for all possible values of payload-type.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

no src-mac

Parameters

ieee-address

Specifies the unicast source MAC address.

Values

a hexadecimal string using the notation xx:xx:xx:xx:xx:xx.The values for xx can be in the range of 0 to 9 and a to f.

src-port

Syntax

src-port src-port-number

no src-port

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the source port to use in the TCP header of the frame generated by the testhead tool.

This value must be specified when the payload-type is configured as tcp-ipv4 or udp-ipv4. The testhead tool does not use the value specified with this command if the payload-type is set to l2 or ipv4.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Default

no src-port, if the payload-type is set to tcp-ipv4 or udp-ipv4

Parameters

src-port-number

The source TCP/UDP port number to use in the frame’s TCP/UDP header.

Values

a valid TCP/UDP port number in decimal or hexadecimal, in the range 0 to 65535

vlan-tag-1

Syntax

vlan-tag-1 vlan-id vlan-id-value [tpid tpid value] [dot1p dot1p-value]

no vlan-tag-1

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the VLAN ID, dot1p bit, and TPID value to be used for the outermost VLAN tag (often called the outer VLAN) in the frame generated by the testhead OAM tool.

Configuration of this parameter is optional and it is used for all possible values of payload-type, if configured.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Note:
  • For the frame generated by the tool to be processed successfully on SAP ingress, the TPID value configured with this command must match either the QinQ Ethertype value in use on the port on which the test SAP is configured or it must match 0x8100 if the test SAP is configured on a dot1q encapsulation port. If this value does not match the value configured under the port, frames generated by the testhead tool are dropped by the node on SAP ingress due to an Ethertype mismatch.

  • For the frame generated by the tool to be processed successfully on SAP ingress, the VLAN ID configured with this command must match the outermost VLAN tag of the QinQ SAP or the Dot1q SAP used for the test SAP. If this value does not match the value configured for the SAP, frames generated by the testhead tool are dropped by the node on SAP ingress due to a VLAN ID mismatch.

  • The dot1p bits specified for the outermost tag can be used for SAP ingress QoS classification.

Default

no vlan-tag-1

Parameters

vlan-id-value

Specifies the VLAN ID used for the VLAN tag. A value must be specified if this command is configured; there is no default value.

Values

0 to 409

tpid-value

Specifies the TPID (also known as Ethertype) to use for the VLAN tag addition. If no value is specified, the TPID defaults to 0x8100.

Values

any valid Ethertype value allowed for use with VLAN tags, in the range 0x0600 to 0xffff

dot1p-value

Specifies the value used to populate the dot1p bits in the VLAN tag. If no value is specified, the dot1p setting defaults to 0.

Values

0 to 7

vlan-tag-2

Syntax

vlan-tag-2 vlan-id vlan-id-value [tpid tpid value] [dot1p dot1p-value]

no vlan-tag-2 vlan-id vlan-id-value [tpid tpid value] [dot1p dot1p-value]

Context

configure>test-oam>testhead-profile>frame-payload

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the VLAN ID, dot1p bit, and TPID value to be used for the second VLAN tag (often called the inner VLAN or the C-VLAN) in the frame generated by the testhead OAM tool.

Configuration of this parameter is optional and it is used for all possible values of payload-type, if configured.

The no form of this command indicates that the field is not to be used in the frame generated by the tool.

Note:

  • The TPID value configured with this command must be 0x8100 in order for the frame generated by the testhead tool to be processed successfully on SAP ingress. If this value does not match 0x8100, frames generated by the tool are dropped by the node on SAP ingress due to an Ethertype mismatch (7210 SAS supports only 0x8100 as the Ethertype value for the inner VLAN tag).

  • The VLAN ID configured with this command must match the outermost VLAN tag of the QinQ SAP or the dot1q SAP used for the test SAP in order for the frame generated by the tool to be processed successfully on SAP ingress. If this value does not match the value configured for the SAP, frames generated by the testhead tool are dropped by the node on SAP ingress due to a VLAN ID mismatch.

  • The dot1p bits specified for the outermost tag can be used for SAP ingress QoS classification.

Default

no vlan-tag-2

Parameters

vlan-id-value

Specifies the VLAN ID used for the VLAN tag. A value must be specified if this command is configured; there is no default value.

Values

0 to 4094

tpid-value

Specifies the TPID (also knows as Ethertype) to use for the VLAN tag addition. If no value is specified, the TPID defaults to 0x8100.

Values

any valid Ethertype value allowed for use with VLAN tags, in the range 0x0600 to 0xffff

dot1p-value

Specifies the value used to populate the dot1p bits in the VLAN tag. If no value is specified, the dot1p setting defaults to 0.

Values

0 to 7

frame-size

Syntax

frame-size frame-size

no frame-size

Context

config>test-oam>testhead-profile

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the frame size of the packets generated by the testhead tool. Any frame size in the given range can be specified.

The no form of this command sets the command to the default value.

Default

512 bytes

Parameters

frame-size

Specifies the size of the frame generated by the testhead tool, in bytes.

Values

64 to 9212

rate

Syntax

rate cir cir-rate-in-kbps [adaptation-rule adaptation-rule] [pir pir-rate-in-kbps]

no rate

Context

config>test-oam>testhead-profile

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command configures the committed information rate (CIR) and peak information rate (PIR) for a testhead profile.

Note:

The testhead uses the Layer 2 rate, which is calculated by subtracting the Layer 1 overhead that is caused when the IFG and Preamble are added to every Ethernet frame (typically about 20 bytes (IFG = 12 bytes and Preamble = 8 bytes)). The testhead tool uses the user-configured frame size to compute the Layer 2 rate and does not allow the user to configure a value greater than that rate. For 512-byte Ethernet frames, the L2 rate is 962406 Kb/s and the Layer 1 rate is 1 Gb/s.

If the optional PIR rate is not specified, the testhead tool generates traffic up to the configured CIR rate. The CIR rate specifies the bandwidth or throughput that the user needs to validate. If specified, the PIR value must be greater than or equal to the CIR value. The testhead tool then generates traffic up to the configured PIR value.

Configure the adaptation-rule parameter to derive the operational hardware rate for both the CIR and PIR. The software finds the best operational rate based on the user-specified constraint and the hardware-based rate supported on the platform.

The no form of this command sets the CIR value to the default; the PIR value is not set. Consequently, if the testhead tool is run after the no rate command is run, the test generates traffic up to the configured CIR rate.

Default

rate cir 1000 adaptation-rule closest

Parameters

cir-rate-in-kbps

Specifies the cir parameter, in kilobits per second (Kb/s), which overrides the default CIR value. The configured value must be a positive integer; fractional values are not allowed. The actual CIR rate depends on the meter adaptation-rule parameters and the hardware. If the rate command is not executed or the CIR parameter is not explicitly specified, the default CIR value applies.

Values

0 to 10000000, max

adaptation-rule

Specifies the constraints enforced when adapting the CIR and PIR, defined using the rate command, to the hardware rates supported by the platform. The adaptation-rule parameter requires a qualifier that defines the constraint used to derive the operational CIR and PIR. If the adaptation-rule is not specified, the default of closest applies. The max (maximum), min (minimum), and closest qualifiers are mutually exclusive.

Default

closest

Values

max — Specifies that the operational PIR or CIR value is equal to or less than the specified rate, taking into account the hardware step size. The hardware step size varies based on the rate and the platform.

min — Specifies that the operational PIR or CIR value is equal to or greater than the specified rate, taking into account the hardware step size. The hardware step size varies based on the rate and the platform.

closest — Specifies that the operational PIR or CIR value is equal to the closest specified rate, taking into account the hardware step size. The hardware step size varies based on the rate and the platform.

pir-rate-in-kbps

Specifies the pir parameter, in kilobits per second (Kb/s), which overrides the default administrative PIR value. The configured value must be a positive integer; fractional values are not allowed. The actual PIR rate depends on the meter adaptation-rule parameters and the hardware. If the rate command is not executed or the PIR parameter is not explicitly specified, the default PIR value is used.

Values

0 to 10000000, max

test-completion-trap-enable

Syntax

[no] test-completion-trap-enable

Context

configure>test-oam>testhead-profile

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command specifies that the test completion trap needs to be generated after the completion of the test, or if the test is stopped. The trap contains the details of the test configuration, the measured values, the test completion status, and the PASS/FAIL result.

The no form of this command disables the generation of the trap upon test completion.

Default

no test-completion-trap-enable

test-duration

Syntax

test-duration {[hours hours] [minutes minutes] [seconds seconds]}

no test-duration

Context

config>test-oam>testhead-profile

Platforms

7210 SAS-D, 7210 SAS-Dxp, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T

Description

This command specifies the total test duration to be used for throughput measurement. The test duration can be specified in number of hours, number of minutes, or number of seconds. When all of the parameters are specified together, the total test duration is set to the sum of the values specified for hours, minutes, and seconds.

The no form of this command sets the value to the default value.

Default

no test-duration (sets the test duration for 3 minutes).

Parameters

hours

Specifies the total number of hours to run the test.The total test duration is determined by the sum of the specified hours, minutes, and seconds.

Values

0 to 24

minutes

The total number of minutes to run the test.The total test duration is determined by the sum of the specified hours, minutes, and seconds.

Values

0 to 60

seconds

The total number of seconds to run the test. The total test duration is determined by the sum of the specified hours, minutes, and seconds.

Values

0 to 60