TWAMP Light commands

twamp-light

Syntax

twamp-light

Context

config>router

config>service>vprn

config>test-oam>twamp

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

Commands in this context configure TWAMP Light functionality.

Note:

The config>service>vprn context is supported on all 7210 SAS platforms as described in this document, except those operating in access-uplink mode.

reflector

Syntax

reflector [udp-port udp-port-number] [create]

no reflector

Context

config>router>twamp-light

config>service>vprn>twamp-light

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures TWAMP Light session reflector-specific parameters. To create a reflector, the user must configure the udp-port-number value and include the create keyword.

The no form of this command removes the reflector.

Note:

The config>service>vprn>twamp-light context is supported on all 7210 SAS platforms as described in this document, except those operating in access-uplink mode.

Parameters

udp-port-number

Specifies the destination UDP port that the session reflector listens to for TWAMP Light packets. The session controller that is launching the TWAMP Light packets must have the same destination UDP port configured as part of the TWAMP Light test. IES services use the destination UDP port that is configured under the router context. Only one UDP port may be configured per unique context. An error message is generated if the specified UDP port is unavailable.

Values

862, 64364 to 64373

create

Creates the reflector.

description

Syntax

description description-string

no description

Context

config>router>twamp-light>reflector

config>router>twamp-light>reflector>prefix

config>service>vprn>twamp-light>reflector

config>service>vprn>twamp-light>reflector>prefix

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

Note:

The config>service>vprn>twamp-light>reflector and config>service>vprn>twamp-light>reflector>prefix contexts are supported on all 7210 SAS platforms as described in this document, except those operating in access-uplink mode.

This command creates a text description for the current configuration context that is stored in the configuration file. The description command associates a text string with a configuration context to help identify the content in the configuration file.

The no form of this command removes the description.

Parameters

description-string

Specifies the description character string. Allowed values are any character strings up to 80 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed in double quotes.

prefix

Syntax

prefix ip-prefix/prefix-length [create]

no prefix ip-prefix/prefix-length

Context

config>router>twamp-light>reflector

config>service>vprn>twamp-light>reflector

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the IP prefixes that the reflector accepts TWAMP Light packets from and respond to. Each prefix requires its own configuration entry.

The no form of this command removes the specifies prefix.

Note:

The config>service>vprn>twamp-light>reflector context is supported on all 7210 SAS platforms as described in this document, except those operating in access-uplink mode.

Parameters

ip-prefix

Specifies the IP address.

Values

IPv4 address in the form a.b.c.d

IPv6 address in the form x:x:x:x:x:x:x:x (eight 6-bit pieces) (no multicast addresses)

x:x:x:x:x:x:d.d.d.d

x [0..FFFF]H

d [0..255]D

prefix-length

Specifies the length of the IP prefix.

Values

IPv4 — 0 to 32

IPv6 — 0 to 128

create

Keyword used to create the IP prefix entry.

shutdown

Syntax

[no] shutdown

Context

config>router>twamp-light>reflector

config>service>vprn>twamp-light>reflector

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command disables the TWAMP Light reflector functionality within the current context.

The no form of this command enables the TWAMP Light reflector functionality within the current context.

Note:

The config>service>vprn>twamp-light>reflector context is supported on all 7210 SAS platforms as described in this document, except those operating in access-uplink mode.

Default

shutdown

inactivity-timeout

Syntax

inactivity-timeout seconds

no inactivity-timeout

Context

config>test-oam>twamp>twamp-light

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the length of time to maintain stale states on the session reflector. A stale state occurs when test data information has not been refreshed or updated by newly arriving probes for that specific test in a predetermined amount of time. Any single reflector can maintain an up state for a maximum of 12000 tests. If the maximum value is exceeded, the session reflector does not have memory to allocate to new tests.

The no form of this command disables the inactivity timer.

Default

inactivity-timer 100

Parameters

seconds

Specifies the number of seconds to maintain a stale state.

Values

10 to 100

session

Syntax

session session-name [test-family {ethernet | ip} [session-type {proactive | on-demand}] create]

no session session-name

Context

config>oam-pm

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the individual session containers that house the test-specific configuration parameters. Because this session context provides only a container abstract to house the individual test functions, it cannot be shut down. Only individual tests sessions within the container may be shut down. No values, parameters, or configuration within this context may be changed if any individual test is active. Changes may only be made when all tests within the context are shut down, with the exception of the description.

The no form of this command removes the session.

Parameters

session-name

Specifies the name of the session container. 32 characters maximum.

ethernet

Specifies that the test is based on the Ethernet layer.

ip

Specifies that the test is based on the IP layer.

proactive

Specifies that the test is always on, with no stop. Tests are proactive by default.

on-demand

Specifies that the test runs on demand, with an immediate start and no stop, or a stop based on offset.

create

Keyword to create the session container.

ip

Syntax

ip

Context

config>oam-pm>session

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

Commands in this context configure the IP-specific source and destination information, the priority, and the IP test tools on the launch point.

destination

Syntax

destination ip-address

no destination

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the destination IP address to which the TWAMP Light packets are addressed. The destination address must be included in the prefix list on the session reflector within the context to allow the reflector to process the inbound TWAMP Light packets.

The no form of this command removes the destination parameters.

Default

no destination

Parameters

ip-address

Specifies the IP address of the peer to which the packets are directed.

Values

IPv4 address in the form a.b.c.d

IPv6 address in the form x:x:x:x:x:x:x:x (eight 6-bit pieces) (no multicast addresses)

x:x:x:x:x:x:d.d.d.d

x [0..FFFF]H

d [0..255]D

dest-udp-port

Syntax

dest-udp-port udp-port-number

no dest-udp-port

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the destination UDP port to which the TWAMP Light packets are sent from the session controller. This value must match the udp-port udp-port number configured on the TWAMP Light reflector that responds to this specific TWAMP Light test.

The no form of this command removes the destination UDP port configuration.

Parameters

udp-port-number

Specifies the destination UDP port.

Values

1 to 65535

fc

Syntax

fc fc-name

no fc

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the forwarding class designation for TWAMP Light packets that are sent through the node and exposed to the various QoS functions on the network element.

The no form of this command restores the default value.

Default

fc be

Parameters

fc-name

Specifies the forwarding class.

Values

be — best effort

l2 — low-2

af — assured

l1 — low-1

h2 — high-2

ef — expedited

h1 — high-1

nc — network control

forwarding

Syntax

forwarding bypass-routing

forwarding interface interface-name

forwarding next-hop ip-address

no forwarding

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures influence for the forwarding decision of the TWAMP Light packet. When this command is used, only one of the forwarding options can be enabled at any time.

The no form of this command removes the configured influence and enables the default forwarding logic.

Default

no forwarding

Parameters

bypass-routing

Specifies that packets should be sent to a host on a directly attached network, bypassing the routing table.

interface-name

Specifies the name of the interface from which the packet is sent. The name must already exist in the config>router>interface context or within the appropriate config>service context. 32 characters maximum.

ip-address

Specifies the IP address of the next hop.

Values

IPv4 address in the form a.b.c.d

IPv6 address in the form x:x:x:x:x:x:x:x (eight 6-bit pieces) (no multicast addresses)

x:x:x:x:x:x:d.d.d.d

x [0..FFFF]H

d [0..255]D

profile

Syntax

profile {in | out}

no profile

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures whether TWAMP Light PDUs are treated as in-profile or out-of-profile.

The no form of this command restores the default value. The default has been selected because the forwarding class defaults to best effort.

Default

profile out

Parameters

in

Specifies that TWAMP Light PDU packets are treated as in-profile.

out

Specifies that TWAMP Light PDU packets are treated as out-of-profile.

router

Syntax

router router-instance

router service-name service-name

no router

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the source context from which TWAMP Light packets are launched. The routing instance and service name must be a VPRN instance.

Note:

VPRN instances may only be specified on 7210 SAS platforms that support VPRN services. See the platform-specific 7210 SAS-Mxp, R6, R12, S, Sx, T Quality of Service Guide for information about platform support for VPRN services.

The no form of this command restores the default value.

Default

router base

Parameters

router-instance

Specifies the routing instance from which the TWAMP Light packets are launched.

Values

router-name | service-id

router-name — ‟base”

service-id — 1 to 2147483647

service-name

Specifies the name of the service from which the TWAMP Light packets are launched. 64 characters maximum.

source

Syntax

source ip-address

no source

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the source IP address that the session controller (launch point) uses for the test. The source address must be a local resident IP address in the context; otherwise, the response packets are not processed by the TWAMP Light application. Only source addresses configured as part of TWAMP tests are able to process the reflected TWAMP packets from the session reflector.

The no form of this command removes the source address parameters.

Parameters

ip-address

Specifies the source IP address.

Values

IPv4 address in the form a.b.c.d

IPv6 address in the form x:x:x:x:x:x:x:x (eight 6-bit pieces) (no multicast addresses)

x:x:x:x:x:x:d.d.d.d

x [0..FFFF]H

d [0..255]D

source-udp-port

Syntax

source-udp-port udp-port-number

no source-udp-port

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command restricts the source UDP range. When this command is omitted, the source UDP port is dynamically allocated by the system. This command should only be used if a TWAMP Client is used to establish a TCP connection and communicate the test parameters to a TWAMP Server over TWAMP TCP Control, and the test is launched from OAM-PM (Session-Sender). This command should not be used when the reflection point is a TWAMP Light reflector that does not require TCP TWAMP Control.

The no form of this command removes the source UDP port configuration and enables default allocation.

Default

no source-udp-port

Parameters

udp-port-number

Specifies the source UDP port.

Values

64374 to 64383

ttl

Syntax

ttl time-to-live

no ttl

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the value of the TTL (time to live) field in the IP header.

The no form of this command restores the default value.

Default

ttl 255

Parameters

time-to-live

Specifies the numerical value to place in the TTL field.

Values

1 to 255

twamp-light

Syntax

twamp-light [test-id test-id] [create]

no twamp-light

Context

config>oam-pm>session>ip

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command assigns an identifier to the TWAMP Light test and creates the individual test.

The no form of this command removes the TWAMP Light test function from the OAM-PM session.

Default

no twamp-light

Parameters

test-id

Specifies the value of the 4-byte local test identifier that is not sent in TWAMP Light packets.

Values

0 to 2147483647

create

Creates the test.

interval

Syntax

interval milliseconds

no interval

Context

config>oam-pm>session>ip>twamp-light

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the message period, or probe spacing, for the transmission of TWAMP Light frames.

The no form of this command restores the default value.

Parameters

milliseconds

Specifies the number of milliseconds between the transmission of TWAMP Light frames.

Values

100, 1000, 10000 (7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx/S 1/10GE, 7210 SAS-Sx 10/100GE, 7210 SAS-T)

100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 10000 (7210 SAS-Mxp)

loss

Syntax

loss

Context

config>oam-pm>session>ip>twamp-light

Description

Commands in this context configure loss parameters for the TWAMP-Light test.

pad-size

Syntax

pad-size octets

no pad-size

Context

config>oam-pm>session>ip>twamp-light

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the amount by which the TWAMP Light packets are padded. TWAMP session-controller packets are 27 bytes smaller than TWAMP session-reflector packets. If symmetrical packet sizes in the forward and backward direction are required, a minimum padding of 27 bytes must be configured.

The no form of this command removes all padding.

Default

pad-size 0

Parameters

padding

Specifies the size of the padding, in octets.

Values

0 to 2000

record-stats

Syntax

record-stats {delay | loss | delay-and-loss}

no record-stats

Context

config>oam-pm>session>ip>twamp-light

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command configures the statistics that are recorded and reported for the TWAMP-Light PDU.

The TWAMP-Light PDU can report on both delay and loss using a single packet. The user can choose which statistics to report. Only delay recording is enabled by default. All other metrics are ignored.

To change the record statistics configuration, the user must shut down the TWAMP-Light session. This is required because base statistics are shared among various datasets as a result of the single packet approach of the TWAMP-Light PDU. Issuing a no shutdown command clears all previous non-volatile memory for the session and allocates new memory blocks.

All command parameters are mutually exclusive.

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

Default

record-stats delay

Parameters

delay

Specifies to report on delay using a single packet.

loss

Specifies to report on loss using a single packet.

delay-and-loss

Specifies to report on both delay and loss using a single packet.

shutdown

Syntax

[no] shutdown

Context

config>oam-pm>session>ip>twamp-light

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This command starts or stops the test.

Default

shutdown

test-duration

Syntax

test-duration seconds

no test-duration

Context

config>oam-pm>session>ip>twamp-light

Platforms

Supported on all 7210 SAS platforms as described in this document, including platforms configured in the access-uplink operating mode

Description

This optional command configures the length of time that the test runs before stopping automatically. This command is only a valid option when a session-type is configured as on-demand. This command is not an option when the session-type is configured as proactive.

The no form of this command removes a previously configured test-duration value and allows the TWAMP Light test to execute until it is stopped manually.

Default

test-duration 0

Parameters

seconds

Specifies the length of time, in seconds, that the TWAMP light test runs.

Values

1 to 86400