46. saa Commands

configure
— saa
— apply-groups reference
— apply-groups-exclude reference
— owner string test string
— accounting-policy reference
— admin-state keyword
— apply-groups reference
— apply-groups-exclude reference
— continuous boolean
— description string
— jitter-event keyword threshold-type keyword
— apply-groups reference
— apply-groups-exclude reference
— threshold number
— latency-event keyword threshold-type keyword
— apply-groups reference
— apply-groups-exclude reference
— threshold number
— loss-event keyword threshold-type keyword
— apply-groups reference
— apply-groups-exclude reference
— threshold number
— probe-history keyword
— type
— apply-groups reference
— apply-groups-exclude reference
— bypass-routing boolean
— count number
— destination-address (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)
— do-not-fragment boolean
— interface string
— interval (number | decimal-number)
— next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)
— pattern (keyword | number)
— qos
— fc keyword
— tos number
— router-instance string
— size number
— source-address (ipv4-address-no-zone | ipv6-address-no-zone)
— timeout number
— ttl number

46.1. saa Command Descriptions

saa

Synopsis

Enter the saa context

Context

configure saa

Tree

saa

Introduced

16.0.R4

Platforms

All

owner [owner-name] string test string

Synopsis

Enter the owner list instance

Context

configure saa owner string test string

Tree

owner

Introduced

16.0.R4

Platforms

All

[owner-name] string

Synopsis

An owner-name identifies a set of SAA tests.

Context

configure saa owner string test string

String Length

1 to 32

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

test string

Synopsis

An owner-name and a test-name identify an SAA test.

Context

configure saa owner string test string

String Length

1 to 32

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

accounting-policy reference

Warning:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

Synopsis

Accounting policy associated with the SAA test

Context

configure saa owner string test string accounting-policy reference

Tree

accounting-policy

Reference

configure log accounting-policy number

Introduced

16.0.R4

Platforms

All

admin-state keyword

Synopsis

Administrative state of the SAA test

Context

configure saa owner string test string admin-state keyword

Tree

admin-state

Default

disable

Options

enable, disable

Introduced

16.0.R4

Platforms

All

continuous boolean

Warning:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

Synopsis

Repeat the test automatically while it is administratively enabled.

Context

configure saa owner string test string continuous boolean

Tree

continuous

Default

false

Introduced

16.0.R4

Platforms

All

description string

Synopsis

Text description

Context

configure saa owner string test string description string

Tree

description

String Length

1 to 80

Introduced

16.0.R4

Platforms

All

jitter-event [direction] keyword threshold-type keyword

Synopsis

Enter the jitter-event list instance

Context

configure saa owner string test string jitter-event keyword threshold-type keyword

Tree

jitter-event

Introduced

16.0.R4

Platforms

All

[direction] keyword

Synopsis

Inbound, outbound, or round trip packet flow.

Context

configure saa owner string test string jitter-event keyword threshold-type keyword

Options

inbound, outbound, round-trip

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

threshold-type keyword

Synopsis

Rising or falling threshold.

Context

configure saa owner string test string jitter-event keyword threshold-type keyword

Options

rising, falling

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

threshold number

Synopsis

Rising or falling threshold (in microseconds) for jitter.

Context

configure saa owner string test string jitter-event keyword threshold-type keyword threshold number

Tree

threshold

Range

0 to 2147483647

Units

microseconds

Notes

This element is mandatory.

Introduced

16.0.R4

Platforms

All

latency-event [direction] keyword threshold-type keyword

Synopsis

Enter the latency-event list instance

Context

configure saa owner string test string latency-event keyword threshold-type keyword

Tree

latency-event

Introduced

16.0.R4

Platforms

All

[direction] keyword

Synopsis

Inbound, outbound, or round trip packet flow.

Context

configure saa owner string test string latency-event keyword threshold-type keyword

Options

inbound, outbound, round-trip

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

threshold-type keyword

Synopsis

Rising or falling threshold.

Context

configure saa owner string test string latency-event keyword threshold-type keyword

Options

rising, falling

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

threshold number

Synopsis

Rising or falling threshold (in microseconds) for packet latency.

Context

configure saa owner string test string latency-event keyword threshold-type keyword threshold number

Tree

threshold

Range

0 to 2147483647

Units

microseconds

Notes

This element is mandatory.

Introduced

16.0.R4

Platforms

All

loss-event [direction] keyword threshold-type keyword

Synopsis

Enter the loss-event list instance

Context

configure saa owner string test string loss-event keyword threshold-type keyword

Tree

loss-event

Introduced

16.0.R4

Platforms

All

[direction] keyword

Synopsis

Inbound, outbound, or round trip packet flow.

Context

configure saa owner string test string loss-event keyword threshold-type keyword

Options

inbound, outbound, round-trip

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

threshold-type keyword

Synopsis

Rising or falling threshold.

Context

configure saa owner string test string loss-event keyword threshold-type keyword

Options

rising, falling

Notes

This element is part of a list key.

Introduced

16.0.R4

Platforms

All

threshold number

Synopsis

Rising or falling threshold for packet loss.

Context

configure saa owner string test string loss-event keyword threshold-type keyword threshold number

Tree

threshold

Range

0 to 2147483647

Units

packets

Notes

This element is mandatory.

Introduced

16.0.R4

Platforms

All

probe-history keyword

Warning:

Modifying this element toggles the admin-state of the parent element automatically for the new value to take effect.

Synopsis

Keep or drop the per-probe test results after a test run completes. 'auto' allows SROS to decide.

Context

configure saa owner string test string probe-history keyword

Tree

probe-history

Default

auto

Options

keep, drop, auto

Introduced

16.0.R4

Platforms

All

type

Synopsis

Enter the type context

Context

configure saa owner string test string type

Tree

type

Introduced

16.0.R4

Platforms

All

icmp-ping

Synopsis

Enable the icmp-ping context

Context

configure saa owner string test string type icmp-ping

Tree

icmp-ping

Introduced

16.0.R4

Platforms

All

bypass-routing boolean

Synopsis

Bypass the routing table when sending to a host on a directly attached network.

Context

configure saa owner string test string type icmp-ping bypass-routing boolean

Tree

bypass-routing

Default

false

Notes

The following are part of a choice: bypass-routing, interface, or next-hop-address.

Introduced

16.0.R4

Platforms

All

count number

Synopsis

Number of ICMP Echo Request packet(s) to send.

Context

configure saa owner string test string type icmp-ping count number

Tree

count

Range

1 to 100000

Default

5

Units

packets

Introduced

16.0.R4

Platforms

All

destination-address (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)

Synopsis

IP address or DNS name to be pinged.

Context

configure saa owner string test string type icmp-ping destination-address (ipv4-address-no-zone | ipv6-address-no-zone | string-not-all-spaces)

Tree

destination-address

String Length

1 to 128

Notes

This element is mandatory.

Introduced

16.0.R4

Platforms

All

do-not-fragment boolean

Synopsis

Do not allow the ICMP Echo Request packet(s) to be fragmented (valid for IPv4 only).

Context

configure saa owner string test string type icmp-ping do-not-fragment boolean

Tree

do-not-fragment

Default

false

Introduced

16.0.R4

Platforms

All

interface string

Synopsis

Sending interface for the ICMP Echo Request packet(s).

Context

configure saa owner string test string type icmp-ping interface string

Tree

interface

String Length

1 to 32

Notes

The following are part of a choice: bypass-routing, interface, or next-hop-address.

Introduced

16.0.R4

Platforms

All

interval (number | decimal-number)

Synopsis

Interval (in seconds) between ICMP Echo Request packets sent.

Context

configure saa owner string test string type icmp-ping interval (number | decimal-number)

Tree

interval

Range

1 to 10000

Default

1

Units

seconds

Introduced

16.0.R4

Platforms

All

next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)

Synopsis

Next hop IP address used when sending ICMP Echo Request packet(s).

Context

configure saa owner string test string type icmp-ping next-hop-address (ipv4-address-no-zone | ipv6-address-no-zone)

Tree

next-hop-address

Notes

The following are part of a choice: bypass-routing, interface, or next-hop-address.

Introduced

16.0.R4

Platforms

All

pattern (keyword | number)

Synopsis

Two byte value used to pad the ICMP Echo Request packet(s). 'sequential' indicates bytes increasing by one.

Context

configure saa owner string test string type icmp-ping pattern (keyword | number)

Tree

pattern

Range

0 to 65535

Default

sequential

Options

sequential

Introduced

16.0.R4

Platforms

All

qos

Synopsis

Enter the qos context

Context

configure saa owner string test string type icmp-ping qos

Tree

qos

Introduced

16.0.R4

Platforms

All

fc keyword

Synopsis

Forwarding Class for the transmitted ICMP Echo Request packet(s).

Context

configure saa owner string test string type icmp-ping qos fc keyword

Tree

fc

Default

nc

Options

be, l2, af, l1, h2, ef, h1, nc

Introduced

16.0.R4

Platforms

All

tos number

Synopsis

Type of Service value to be loaded into the DSCP and ECN fields of the IP header of the ICMP Echo Request packet(s).

Context

configure saa owner string test string type icmp-ping qos tos number

Tree

tos

Range

0 to 255

Default

0

Introduced

16.0.R4

Platforms

All

router-instance string

Synopsis

Router used for the test ('Base', 'management', or a VPRN service name).

Context

configure saa owner string test string type icmp-ping router-instance string

Tree

router-instance

Default

Base

Introduced

16.0.R4

Platforms

All

size number

Synopsis

Number of bytes in the combined ICMP Header (8 bytes) and ICMP Payload (variable size) of the ICMP Echo Request packet(s).

Context

configure saa owner string test string type icmp-ping size number

Tree

size

Range

0 to 16384

Default

56

Units

bytes

Introduced

16.0.R4

Platforms

All

source-address (ipv4-address-no-zone | ipv6-address-no-zone)

Synopsis

Source IP address to be loaded into the IP header of the ICMP Echo Request packet(s). Default: a system-selected address.

Context

configure saa owner string test string type icmp-ping source-address (ipv4-address-no-zone | ipv6-address-no-zone)

Tree

source-address

Introduced

16.0.R4

Platforms

All

timeout number

Synopsis

Maximum time (in seconds) to wait for ICMP Echo Reply packet(s). The timer is started when the last ICMP Echo Request is sent.

Context

configure saa owner string test string type icmp-ping timeout number

Tree

timeout

Range

1 to 10

Default

5

Units

seconds

Introduced

16.0.R4

Platforms

All

ttl number

Synopsis

Time To Live value (IPv4) or Hop Limit value (IPv6) to be loaded into the IP header of the ICMP Echo Request packet(s).

Context

configure saa owner string test string type icmp-ping ttl number

Tree

ttl

Range

1 to 128

Default

64

Introduced

16.0.R4

Platforms

All